Commit Graph

12 Commits

Author SHA1 Message Date
Niels Sascha Reedijk
5a6d68bbfa HaikuBook: add instructions for including INTERNAL documentation
Change-Id: Ifb539a0a11d6aa9f496aa493d7a47a08016818be
Reviewed-on: https://review.haiku-os.org/c/haiku/+/3308
Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-10-11 15:46:06 +00:00
Axel Dörfler
40440e7419 Clarified why the documentation does not belong into headers.
* Haiku is slow, and that's why we do not put documentation in headers???
  Hell yeah.
2013-03-22 20:56:17 +01:00
John Scipione
820dca4df6 Big docs cleanup.
* Fixed headers including:
  - All rights reserved not All Rights Reserved.
  - name, email@domain.com not name <email@domain.com>
  - tabs and spaces
  - Authors: not Documented by:
* Renamed string.dox to String.dox
* Renamed midixxx.dox files to MidiXxx.dox
* Moved images into images subdirectories and updated Doxfile.
* Re-format all files with tabs instead of spaces.
* Fix many spelling mistakes.
* Added all files, classes, structs, and enums to libbe group.
2013-02-07 02:01:19 -05:00
Adrien Destugues
e9fd63ec7c * Fix some outdated information in documentation files
* Add a very small part of documentation about the Locale Kit.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37873 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-03 16:02:55 +00:00
Niels Sascha Reedijk
99b3aeed2d git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21837 a95241bf-73f2-0310-859d-f6bbb57e9c96 2007-08-06 14:28:40 +00:00
Niels Sascha Reedijk
ff3d9bfa2a Update the API guidelines to make them more consistent with the coding
guidelines. Three new guidelines:
- Commas between names and email adresses in header blocks.
- Indent with tabs (with lenght 4)
- Two whitelines between blocks


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21832 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-08-06 09:09:29 +00:00
Niels Sascha Reedijk
de41d9ee27 Update the guidelines acording to the decisions during the meeting
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21188 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-21 15:45:39 +00:00
Niels Sascha Reedijk
5625684593 Patch by Alan Smale:
"I have made the doc header consistent with what the document content
specifies it should be.

I've rephrased things and corrected typos and spelling.

Checked through the grammar and amended some gramatical errors."

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21103 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-10 09:02:45 +00:00
Niels Sascha Reedijk
b821eb28c8 git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20838 a95241bf-73f2-0310-859d-f6bbb57e9c96 2007-04-26 11:13:29 +00:00
Niels Sascha Reedijk
81071f5e8a Large documentation update:
- Add the beginnings of the documentation for the USB module
- Fix some mistakes here and there
- Almost finished the support kit. Tried to update everything to the standards

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20724 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-04-16 09:28:29 +00:00
Niels Sascha Reedijk
e24e2c66c9 Push some doc changes I have on my harddrive. They don't (all) conform to the guidelines, but I wanted to put these in the repository nonetheless.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20472 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-03-30 13:50:00 +00:00
Niels Sascha Reedijk
a38ee20f99 Initial revision of the API documentation guidelines up for discussion. DataIO.dox and List.dox conform to these guidelines.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20392 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-03-19 09:38:47 +00:00