Skip to content

Commit

Permalink
Better to have consistent paths...
Browse files Browse the repository at this point in the history
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@40550 a95241bf-73f2-0310-859d-f6bbb57e9c96
  • Loading branch information
phoudoin committed Feb 18, 2011
1 parent a7e6888 commit 7f08510
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/user/HOWTO
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,16 @@ There are two ways to document your kit:

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
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.
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.

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
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).

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",
using the \defgroup and \ingroup tags. In practice, the results of this are a
Expand Down

0 comments on commit 7f08510

Please sign in to comment.