[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Description Document, v.01
From: |
Gervase Lam |
Subject: |
Re: Description Document, v.01 |
Date: |
Sun, 4 Apr 2004 15:55:06 +0100 |
Would it be better to make this document doxygen based? Or is doxygen not
that powerful? I don't know much about doxygen to know the answer to the
question.
The reason I ask is because I think this type of documentation can be
easily broken. For example, there could be a change in the way the levels
are constructed in the code. This could affect the way the Pingus react
with the environment. Therefore, it could be easy to miss editing some
parts of the document to reflect the change.
I can't find the doxygen pages in the Pingus web site at the moment. But
doesn't it already have the facility of documenting what bits of code
calls the method you are looking at?
Thanks,
Gervase.