[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[libredwg] Developer Documentation
From: |
Avneet Kaur |
Subject: |
[libredwg] Developer Documentation |
Date: |
Sat, 20 Jul 2013 13:34:13 +0530 |
When creating software, code alone is insufficient. There must be text
along with it to describe various aspects of its intended operation.
One can easily understand the source code through it's technical documentation.
The idea of auto-generating documentation is attractive to programmers
for various reasons. For example, because it is extracted from the
source code itself (for example, through comments), the programmer can
write it while referring to the code, and use the same tools used to
create the source code to make the documentation. This makes it much
easier to keep the documentation up-to-date.
Doxygen is a documentation generator, a tool for writing software
reference documentation.
So can I use Doxygen for generating technical documentation?
--
Er. Avneet Kaur
Blog: www.avneetkhasla.wordpress.com
"Coming together is a beginning; keeping together is progress; working
together is success."
- [libredwg] Developer Documentation,
Avneet Kaur <=