i2p/haiku-beta6
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clarified why the documentation does not belong into headers.

Browse Source 
* Haiku is slow, and that's why we do not put documentation in headers???
  Hell yeah.
This commit is contained in:
Axel Dörfler
2013-03-22 20:56:17 +01:00
parent e6a0c79790
commit 40440e7419
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/user/apidoc.dox
+5 -5
View File
@@ -53,11 +53,11 @@
in either location, and opt for the third option Doxygen provides: to put in either location, and opt for the third option Doxygen provides: to put
the documentation into separate files. the documentation into separate files.
\note The reasons to not put the documentation in the header files are \note The reasons to not put the documentation in the header files are twofold.
twofold. First of all, it would add unnecessary cruft to the headers First of all, it would add unnecessary cruft to the headers that the
that the compiler will needlessly have to parse. File access and speed compiler will needlessly have to parse, and developers will have a hard
isn't BeOS and Haiku's best quality. The second reason is that the time to find the info they are looking for. The second reason is that
system headers are included throughout the tree. It's a waste of the system headers are included throughout the tree. It's a waste of
electricity to have everybody recompile the entire tree if someone fixes electricity to have everybody recompile the entire tree if someone fixes
a typo in the documentation. Likewise, the reason to not put the a typo in the documentation. Likewise, the reason to not put the
documentation in the source code is that it unnecessarily clutters up documentation in the source code is that it unnecessarily clutters up