Difference between revisions of "Doxygen Documentation"

From Trinity Desktop Project Wiki
Jump to navigation Jump to search
imported>Eliddell
(Created page with "== Outdated Documentation is Dangerous == The KDE team strives to provide documentation for the KDE programming interfaces and libraries that is always up-to-date and correct...")
 
m (Blu256 moved page Doxygen (KDE3 Architecture) to Doxygen Documentation: Simpler name)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
The Trinity team strives to provide '''documentation''' for the TDE programming
== Outdated Documentation is Dangerous ==
 
 
The KDE team strives to provide documentation for the KDE programming
 
 
interfaces and libraries that is always up-to-date and correct. Taking
 
interfaces and libraries that is always up-to-date and correct. Taking
ideas from literate programming and ''Java'', we decided from day
+
ideas from KDE, which in turn was inspired by literate programming and
one to keep the documentation as close to the source as possible.
+
''Java'', we try to keep the documentation as close to the source as possible.
   
 
== Documentation and Source are Joined at the Hip ==
 
== Documentation and Source are Joined at the Hip ==
   
All the KDE API documentation is contained within the library source
+
All the Trinity API documentation is contained within the library source
 
itself. Documentation is written using specially-marked comments.
 
itself. Documentation is written using specially-marked comments.
 
This ensures that the latest library is always shipped with the latest
 
This ensures that the latest library is always shipped with the latest
Line 16: Line 14:
 
== Don't use the Source, Luke ==
 
== Don't use the Source, Luke ==
   
The KDE project uses [http://www.doxygen.org Doxygen], a tool to generate
+
The Trinity Desktop project uses [http://www.doxygen.org Doxygen], a tool to generate
 
easily readable and heavily cross-referenced documentation in a variety of
 
easily readable and heavily cross-referenced documentation in a variety of
hypertext and printable formats. For an example of it's output, browse the [http://api.kde.org/3.5-api/kdelibs-apidocs/ KDE 3.5 API Reference].
+
hypertext and printable formats. For an example of it's output, browse the
  +
[http://trinitydesktop.org/docs/trinity/ Trinity API Reference].
   
 
We also recommend that application developers use ''Doxygen'' while
 
We also recommend that application developers use ''Doxygen'' while

Latest revision as of 15:38, 21 April 2022

The Trinity team strives to provide documentation for the TDE programming interfaces and libraries that is always up-to-date and correct. Taking ideas from KDE, which in turn was inspired by literate programming and Java, we try to keep the documentation as close to the source as possible.

Documentation and Source are Joined at the Hip

All the Trinity API documentation is contained within the library source itself. Documentation is written using specially-marked comments. This ensures that the latest library is always shipped with the latest documentation, and makes it easy for programmers to update and write documentation as the interface grows and changes.

Don't use the Source, Luke

The Trinity Desktop project uses Doxygen, a tool to generate easily readable and heavily cross-referenced documentation in a variety of hypertext and printable formats. For an example of it's output, browse the Trinity API Reference.

We also recommend that application developers use Doxygen while developing their applications, since it acts as a good reference for the developers themselves, or for anyone who wishes to modify or extend the application. Any non-trivial application benefits from an easily browseable and comprehensive API reference.

For detailed information on how to use Doxygen, see the Doxygen home page.


Initial Author: Sirtaj Singh Kang