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

Better to have consistent paths...

Browse Source 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@40550 a95241bf-73f2-0310-859d-f6bbb57e9c96
This commit is contained in:
Philippe Houdoin
2011-02-18 12:32:18 +00:00
parent a7e6888c00
commit 7f08510a9a
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/user/HOWTO
+3 -3
View File
@@ -16,8 +16,8 @@ There are two ways to document your kit:
Either way is fine. The documentation for the Midi Kit, for example, uses the Either way is fine. The documentation for the Midi Kit, for example, uses the
latter option. The files with the Doxygen comments all live in the midi2 subdir latter option. The files with the Doxygen comments all live in the midi2 subdir
of /trunk/docs/user. Of course, if you embed the Doxygen comments directly in of trunk/docs/user. Of course, if you embed the Doxygen comments directly in
your source code, you don't need to make a subdir in /trunk/docs/user. your source code, you don't need to make a subdir in trunk/docs/user.
There is one Doxygen config file (Doxyfile) for the entire book, so you don't There is one Doxygen config file (Doxyfile) for the entire book, so you don't
have to make your own Doxyfile. You just have to add the directories with your have to make your own Doxyfile. You just have to add the directories with your
@@ -25,7 +25,7 @@ commented files to the INPUT directive, so doxygen will know where to find them.
You probably also want to add a link to your kit on the main page (book.dox). You probably also want to add a link to your kit on the main page (book.dox).
To generate the docs, simply type "doxygen" in the Terminal. The script puts To generate the docs, simply type "doxygen" in the Terminal. The script puts
the resulting HTML docs in "/trunk/generated/doxygen/html". the resulting HTML docs in "trunk/generated/doxygen/html".
Note: theoretically, Doxygen allows us to treat each kit as a separate "module", Note: theoretically, Doxygen allows us to treat each kit as a separate "module",
using the \defgroup and \ingroup tags. In practice, the results of this are a using the \defgroup and \ingroup tags. In practice, the results of this are a