[openbeos] Re: First draft of the API documentation guidelines

On 3/20/07, Tyler Akidau <haiku@xxxxxxxxxx> wrote:


I haven't gotten a chance to read the "Writing Guidelines" part yet, but
for most part (excluding my comments below), everything up to that point is
quite well done. I think it gives a very good and thorough intro to the
various commands one might need when writing docs. I like it. :-)



Some minor typos I forgot to mention:

 "Doxygen, the tool that we use to generate the marked up documentation
with,"

I don't think the word "with" is entirely correct or necessary in this
sentence:

 "Every documentation file will begin with the header block. It's basically

  a copyright block, with a reference to the author and with the revision
  against which the documentaton was written."

Should that say "reference to the author(s)"?

-Tyler

Other related posts: