https://wiki.trinitydesktop.net/index.php?action=history&feed=atom&title=Doxygen_Documentation 2026-05-12T23:33:43Z Revision history for this page on the wiki MediaWiki 1.35.13 https://wiki.trinitydesktop.net/index.php?title=Doxygen_Documentation&diff=2215&oldid=prev 2022-04-21T15:38:44Z

<p>Blu256 moved page <a href="/Doxygen_(KDE3_Architecture)" class="mw-redirect" title="Doxygen (KDE3 Architecture)">Doxygen (KDE3 Architecture)</a> to <a href="/Doxygen_Documentation" title="Doxygen Documentation">Doxygen Documentation</a>: Simpler name</p> <table class="diff diff-contentalign-left diff-editfont-monospace" data-mw="interface"> <col class="diff-marker" /> <col class="diff-content" /> <col class="diff-marker" /> <col class="diff-content" /> <tr class="diff-title" lang="en"> <td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">← Older revision</td> <td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">Revision as of 15:38, 21 April 2022</td> </tr> <!-- diff cache key mwdb:diff:wikidiff2:1.12:old-2214:rev-2215:1.13.0 --> </table>

Blu256 https://wiki.trinitydesktop.net/index.php?title=Doxygen_Documentation&diff=2214&oldid=prev 2022-04-21T15:37:53Z

<p>Removed accidentally pasted string</p> <table class="diff diff-contentalign-left diff-editfont-monospace" data-mw="interface"> <col class="diff-marker" /> <col class="diff-content" /> <col class="diff-marker" /> <col class="diff-content" /> <tr class="diff-title" lang="en"> <td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">← Older revision</td> <td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">Revision as of 15:37, 21 April 2022</td> </tr><tr> <td colspan="2" class="diff-lineno">Line 30:</td> <td colspan="2" class="diff-lineno">Line 30:</td> </tr> <tr> <td class="diff-marker"></td> <td class="diff-context diff-side-deleted"><br /></td> <td class="diff-marker"></td> <td class="diff-context diff-side-added"><br /></td> </tr> <tr> <td class="diff-marker"></td> <td class="diff-context diff-side-deleted"><div>''Initial Author:'' [mailto:taj@kde.org Sirtaj Singh Kang]</div></td> <td class="diff-marker"></td> <td class="diff-context diff-side-added"><div>''Initial Author:'' [mailto:taj@kde.org Sirtaj Singh Kang]</div></td> </tr> <tr> <td class="diff-marker" data-marker="−"></td> <td class="diff-deletedline diff-side-deleted"><br /></td> <td colspan="2" class="diff-empty diff-side-added"></td> </tr> <tr> <td class="diff-marker" data-marker="−"></td> <td class="diff-deletedline diff-side-deleted"><div>The Trinity team strives to provide documentation for the TDE programming</div></td> <td colspan="2" class="diff-empty diff-side-added"></td> </tr> <tr> <td class="diff-marker"></td> <td class="diff-context diff-side-deleted"><br /></td> <td class="diff-marker"></td> <td class="diff-context diff-side-added"><br /></td> </tr> <tr> <td class="diff-marker"></td> <td class="diff-context diff-side-deleted"><div>[[Category:KDE3]]</div></td> <td class="diff-marker"></td> <td class="diff-context diff-side-added"><div>[[Category:KDE3]]</div></td> </tr> <!-- diff cache key mwdb:diff:wikidiff2:1.12:old-2210:rev-2214:1.13.0 --> </table>

Blu256 https://wiki.trinitydesktop.net/index.php?title=Doxygen_Documentation&diff=2210&oldid=prev 2022-04-21T15:36:40Z

<p>-Applicable to TDE (redundant), categories to bottom</p> <table class="diff diff-contentalign-left diff-editfont-monospace" data-mw="interface"> <col class="diff-marker" /> <col class="diff-content" /> <col class="diff-marker" /> <col class="diff-content" /> <tr class="diff-title" lang="en"> <td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">← Older revision</td> <td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">Revision as of 15:36, 21 April 2022</td> </tr><tr> <td colspan="2" class="diff-lineno">Line 1:</td> <td colspan="2" class="diff-lineno">Line 1:</td> </tr> <tr> <td colspan="2" class="diff-empty diff-side-deleted"></td> <td class="diff-marker"><a class="mw-diff-movedpara-right" title="Paragraph was moved. Click to jump to old location." href="#movedpara_2_5_lhs">&#x26AB;</a></td> <td class="diff-addedline diff-side-added"><div><a name="movedpara_0_0_rhs"></a>The Trinity team strives to provide <ins class="diffchange diffchange-inline">'''</ins>documentation<ins class="diffchange diffchange-inline">'''</ins> for the TDE programming</div></td> </tr> <tr> <td class="diff-marker"><a class="mw-diff-movedpara-left" title="Paragraph was moved. Click to jump to new location." href="#movedpara_4_3_rhs">&#x26AB;</a></td> <td class="diff-deletedline diff-side-deleted"><div><a name="movedpara_1_0_lhs"></a>[[Category:KDE3]]</div></td> <td colspan="2" class="diff-empty diff-side-added"></td> </tr> <tr> <td class="diff-marker"><a class="mw-diff-movedpara-left" title="Paragraph was moved. Click to jump to new location." href="#movedpara_4_4_rhs">&#x26AB;</a></td> <td class="diff-deletedline diff-side-deleted"><div><a name="movedpara_2_0_lhs"></a>[[Category:Architecture]]</div></td> <td colspan="2" class="diff-empty diff-side-added"></td> </tr> <tr> <td class="diff-marker"><a class="mw-diff-movedpara-left" title="Paragraph was moved. Click to jump to new location." href="#movedpara_4_5_rhs">&#x26AB;</a></td> <td class="diff-deletedline diff-side-deleted"><div><a name="movedpara_2_1_lhs"></a>[[Category:Developers]]</div></td> <td colspan="2" class="diff-empty diff-side-added"></td> </tr> <tr> <td class="diff-marker" data-marker="−"></td> <td class="diff-deletedline diff-side-deleted"><div>{{Applicable to TDE}}</div></td> <td colspan="2" class="diff-empty diff-side-added"></td> </tr> <tr> <td class="diff-marker" data-marker="−"></td> <td class="diff-deletedline diff-side-deleted"><br /></td> <td colspan="2" class="diff-empty diff-side-added"></td> </tr> <tr> <td class="diff-marker" data-marker="−"></td> <td class="diff-deletedline diff-side-deleted"><br /></td> <td colspan="2" class="diff-empty diff-side-added"></td> </tr> <tr> <td class="diff-marker"><a class="mw-diff-movedpara-left" title="Paragraph was moved. Click to jump to new location." href="#movedpara_0_0_rhs">&#x26AB;</a></td> <td class="diff-deletedline diff-side-deleted"><div><a name="movedpara_2_5_lhs"></a>The Trinity team strives to provide documentation for the TDE programming</div></td> <td colspan="2" class="diff-empty diff-side-added"></td> </tr> <tr> <td class="diff-marker"></td> <td class="diff-context diff-side-deleted"><div>interfaces and libraries that is always up-to-date and correct. Taking</div></td> <td class="diff-marker"></td> <td class="diff-context diff-side-added"><div>interfaces and libraries that is always up-to-date and correct. Taking</div></td> </tr> <tr> <td class="diff-marker"></td> <td class="diff-context diff-side-deleted"><div>ideas from KDE, which in turn was inspired by literate programming and</div></td> <td class="diff-marker"></td> <td class="diff-context diff-side-added"><div>ideas from KDE, which in turn was inspired by literate programming and</div></td> </tr> <tr> <td colspan="2" class="diff-lineno">Line 36:</td> <td colspan="2" class="diff-lineno">Line 30:</td> </tr> <tr> <td class="diff-marker"></td> <td class="diff-context diff-side-deleted"><br /></td> <td class="diff-marker"></td> <td class="diff-context diff-side-added"><br /></td> </tr> <tr> <td class="diff-marker"></td> <td class="diff-context diff-side-deleted"><div>''Initial Author:'' [mailto:taj@kde.org Sirtaj Singh Kang]</div></td> <td class="diff-marker"></td> <td class="diff-context diff-side-added"><div>''Initial Author:'' [mailto:taj@kde.org Sirtaj Singh Kang]</div></td> </tr> <tr> <td colspan="2" class="diff-empty diff-side-deleted"></td> <td class="diff-marker" data-marker="+"></td> <td class="diff-addedline diff-side-added"><br /></td> </tr> <tr> <td colspan="2" class="diff-empty diff-side-deleted"></td> <td class="diff-marker" data-marker="+"></td> <td class="diff-addedline diff-side-added"><div>The Trinity team strives to provide documentation for the TDE programming</div></td> </tr> <tr> <td colspan="2" class="diff-empty diff-side-deleted"></td> <td class="diff-marker" data-marker="+"></td> <td class="diff-addedline diff-side-added"><br /></td> </tr> <tr> <td colspan="2" class="diff-empty diff-side-deleted"></td> <td class="diff-marker"><a class="mw-diff-movedpara-right" title="Paragraph was moved. Click to jump to old location." href="#movedpara_1_0_lhs">&#x26AB;</a></td> <td class="diff-addedline diff-side-added"><div><a name="movedpara_4_3_rhs"></a>[[Category:KDE3]]</div></td> </tr> <tr> <td colspan="2" class="diff-empty diff-side-deleted"></td> <td class="diff-marker"><a class="mw-diff-movedpara-right" title="Paragraph was moved. Click to jump to old location." href="#movedpara_2_0_lhs">&#x26AB;</a></td> <td class="diff-addedline diff-side-added"><div><a name="movedpara_4_4_rhs"></a>[[Category:Architecture]]</div></td> </tr> <tr> <td colspan="2" class="diff-empty diff-side-deleted"></td> <td class="diff-marker"><a class="mw-diff-movedpara-right" title="Paragraph was moved. Click to jump to old location." href="#movedpara_2_1_lhs">&#x26AB;</a></td> <td class="diff-addedline diff-side-added"><div><a name="movedpara_4_5_rhs"></a>[[Category:Developers]]</div></td> </tr> <!-- diff cache key mwdb:diff:wikidiff2:1.12:old-1686:rev-2210:1.13.0 --> </table>

Blu256 https://wiki.trinitydesktop.net/index.php?title=Doxygen_Documentation&diff=1686&oldid=prev 2021-08-22T20:34:55Z

<p>Updated for Trinity</p> <table class="diff diff-contentalign-left diff-editfont-monospace" data-mw="interface"> <col class="diff-marker" /> <col class="diff-content" /> <col class="diff-marker" /> <col class="diff-content" /> <tr class="diff-title" lang="en"> <td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">← Older revision</td> <td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">Revision as of 20:34, 22 August 2021</td> </tr><tr> <td colspan="2" class="diff-lineno">Line 1:</td> <td colspan="2" class="diff-lineno">Line 1:</td> </tr> <tr> <td colspan="2" class="diff-empty diff-side-deleted"></td> <td class="diff-marker"><a class="mw-diff-movedpara-right" title="Paragraph was moved. Click to jump to old location." href="#movedpara_15_1_lhs">&#x26AB;</a></td> <td class="diff-addedline diff-side-added"><div><a name="movedpara_0_0_rhs"></a>[[Category:KDE3]]</div></td> </tr> <tr> <td class="diff-marker" data-marker="−"></td> <td class="diff-deletedline diff-side-deleted"><div>== Outdated Documentation is Dangerous ==</div></td> <td colspan="2" class="diff-empty diff-side-added"></td> </tr> <tr> <td colspan="2" class="diff-empty diff-side-deleted"></td> <td class="diff-marker"><a class="mw-diff-movedpara-right" title="Paragraph was moved. Click to jump to old location." href="#movedpara_15_2_lhs">&#x26AB;</a></td> <td class="diff-addedline diff-side-added"><div><a name="movedpara_2_0_rhs"></a>[[Category:Architecture]]</div></td> </tr> <tr> <td colspan="2" class="diff-empty diff-side-deleted"></td> <td class="diff-marker"><a class="mw-diff-movedpara-right" title="Paragraph was moved. Click to jump to old location." href="#movedpara_15_3_lhs">&#x26AB;</a></td> <td class="diff-addedline diff-side-added"><div><a name="movedpara_2_1_rhs"></a>[[Category:Developers]]</div></td> </tr> <tr> <td colspan="2" class="diff-empty diff-side-deleted"></td> <td class="diff-marker" data-marker="+"></td> <td class="diff-addedline diff-side-added"><div>{{Applicable to TDE}}</div></td> </tr> <tr> <td colspan="2" class="diff-empty diff-side-deleted"></td> <td class="diff-marker" data-marker="+"></td> <td class="diff-addedline diff-side-added"><br /></td> </tr> <tr> <td class="diff-marker"></td> <td class="diff-context diff-side-deleted"><br /></td> <td class="diff-marker"></td> <td class="diff-context diff-side-added"><br /></td> </tr> <tr> <td class="diff-marker" data-marker="−"></td> <td class="diff-deletedline diff-side-deleted"><div>The <del class="diffchange diffchange-inline">KDE</del> team strives to provide documentation for the <del class="diffchange diffchange-inline">KDE</del> programming</div></td> <td class="diff-marker" data-marker="+"></td> <td class="diff-addedline diff-side-added"><div>The <ins class="diffchange diffchange-inline">Trinity</ins> team strives to provide documentation for the <ins class="diffchange diffchange-inline">TDE</ins> programming</div></td> </tr> <tr> <td class="diff-marker"></td> <td class="diff-context diff-side-deleted"><div>interfaces and libraries that is always up-to-date and correct. Taking</div></td> <td class="diff-marker"></td> <td class="diff-context diff-side-added"><div>interfaces and libraries that is always up-to-date and correct. Taking</div></td> </tr> <tr> <td class="diff-marker" data-marker="−"></td> <td class="diff-deletedline diff-side-deleted"><div>ideas from <del class="diffchange diffchange-inline">literate</del> <del class="diffchange diffchange-inline">programming</del> <del class="diffchange diffchange-inline">and</del> <del class="diffchange diffchange-inline">''Java'',</del> <del class="diffchange diffchange-inline">we</del> <del class="diffchange diffchange-inline">decided</del> <del class="diffchange diffchange-inline">from</del> <del class="diffchange diffchange-inline">day</del></div></td> <td class="diff-marker" data-marker="+"></td> <td class="diff-addedline diff-side-added"><div>ideas from <ins class="diffchange diffchange-inline">KDE,</ins> <ins class="diffchange diffchange-inline">which</ins> <ins class="diffchange diffchange-inline">in</ins> <ins class="diffchange diffchange-inline">turn</ins> <ins class="diffchange diffchange-inline">was</ins> <ins class="diffchange diffchange-inline">inspired</ins> <ins class="diffchange diffchange-inline">by</ins> <ins class="diffchange diffchange-inline">literate programming and</ins></div></td> </tr> <tr> <td class="diff-marker" data-marker="−"></td> <td class="diff-deletedline diff-side-deleted"><div><del class="diffchange diffchange-inline">one</del> to keep the documentation as close to the source as possible.</div></td> <td class="diff-marker" data-marker="+"></td> <td class="diff-addedline diff-side-added"><div><ins class="diffchange diffchange-inline">''Java'', we try</ins> to keep the documentation as close to the source as possible.</div></td> </tr> <tr> <td class="diff-marker"></td> <td class="diff-context diff-side-deleted"><br /></td> <td class="diff-marker"></td> <td class="diff-context diff-side-added"><br /></td> </tr> <tr> <td class="diff-marker"></td> <td class="diff-context diff-side-deleted"><div>== Documentation and Source are Joined at the Hip ==</div></td> <td class="diff-marker"></td> <td class="diff-context diff-side-added"><div>== Documentation and Source are Joined at the Hip ==</div></td> </tr> <tr> <td class="diff-marker"></td> <td class="diff-context diff-side-deleted"><br /></td> <td class="diff-marker"></td> <td class="diff-context diff-side-added"><br /></td> </tr> <tr> <td class="diff-marker" data-marker="−"></td> <td class="diff-deletedline diff-side-deleted"><div>All the <del class="diffchange diffchange-inline">KDE</del> API documentation is contained within the library source</div></td> <td class="diff-marker" data-marker="+"></td> <td class="diff-addedline diff-side-added"><div>All the <ins class="diffchange diffchange-inline">Trinity</ins> API documentation is contained within the library source</div></td> </tr> <tr> <td class="diff-marker"></td> <td class="diff-context diff-side-deleted"><div>itself. Documentation is written using specially-marked comments.</div></td> <td class="diff-marker"></td> <td class="diff-context diff-side-added"><div>itself. Documentation is written using specially-marked comments.</div></td> </tr> <tr> <td class="diff-marker"></td> <td class="diff-context diff-side-deleted"><div>This ensures that the latest library is always shipped with the latest</div></td> <td class="diff-marker"></td> <td class="diff-context diff-side-added"><div>This ensures that the latest library is always shipped with the latest</div></td> </tr> <tr> <td colspan="2" class="diff-lineno">Line 16:</td> <td colspan="2" class="diff-lineno">Line 20:</td> </tr> <tr> <td class="diff-marker"></td> <td class="diff-context diff-side-deleted"><div>== Don't use the Source, Luke ==</div></td> <td class="diff-marker"></td> <td class="diff-context diff-side-added"><div>== Don't use the Source, Luke ==</div></td> </tr> <tr> <td class="diff-marker"></td> <td class="diff-context diff-side-deleted"><br /></td> <td class="diff-marker"></td> <td class="diff-context diff-side-added"><br /></td> </tr> <tr> <td class="diff-marker" data-marker="−"></td> <td class="diff-deletedline diff-side-deleted"><div>The <del class="diffchange diffchange-inline">KDE</del> project uses [http://www.doxygen.org Doxygen], a tool to generate</div></td> <td class="diff-marker" data-marker="+"></td> <td class="diff-addedline diff-side-added"><div>The <ins class="diffchange diffchange-inline">Trinity Desktop</ins> project uses [http://www.doxygen.org Doxygen], a tool to generate</div></td> </tr> <tr> <td class="diff-marker"></td> <td class="diff-context diff-side-deleted"><div>easily readable and heavily cross-referenced documentation in a variety of</div></td> <td class="diff-marker"></td> <td class="diff-context diff-side-added"><div>easily readable and heavily cross-referenced documentation in a variety of</div></td> </tr> <tr> <td class="diff-marker" data-marker="−"></td> <td class="diff-deletedline diff-side-deleted"><div>hypertext and printable formats. For an example of it's output, browse the<del class="diffchange diffchange-inline"> [http://api.kde.org/3.5-api/kdelibs-apidocs/ KDE 3.5 API Reference].</del></div></td> <td class="diff-marker" data-marker="+"></td> <td class="diff-addedline diff-side-added"><div>hypertext and printable formats. For an example of it's output, browse the</div></td> </tr> <tr> <td colspan="2" class="diff-empty diff-side-deleted"></td> <td class="diff-marker" data-marker="+"></td> <td class="diff-addedline diff-side-added"><div>[http://trinitydesktop.org/docs/trinity/ Trinity API Reference].</div></td> </tr> <tr> <td class="diff-marker"></td> <td class="diff-context diff-side-deleted"><br /></td> <td class="diff-marker"></td> <td class="diff-context diff-side-added"><br /></td> </tr> <tr> <td class="diff-marker"></td> <td class="diff-context diff-side-deleted"><div>We also recommend that application developers use ''Doxygen'' while</div></td> <td class="diff-marker"></td> <td class="diff-context diff-side-added"><div>We also recommend that application developers use ''Doxygen'' while</div></td> </tr> <tr> <td colspan="2" class="diff-lineno">Line 31:</td> <td colspan="2" class="diff-lineno">Line 36:</td> </tr> <tr> <td class="diff-marker"></td> <td class="diff-context diff-side-deleted"><br /></td> <td class="diff-marker"></td> <td class="diff-context diff-side-added"><br /></td> </tr> <tr> <td class="diff-marker"></td> <td class="diff-context diff-side-deleted"><div>''Initial Author:'' [mailto:taj@kde.org Sirtaj Singh Kang]</div></td> <td class="diff-marker"></td> <td class="diff-context diff-side-added"><div>''Initial Author:'' [mailto:taj@kde.org Sirtaj Singh Kang]</div></td> </tr> <tr> <td class="diff-marker" data-marker="−"></td> <td class="diff-deletedline diff-side-deleted"><br /></td> <td colspan="2" class="diff-empty diff-side-added"></td> </tr> <tr> <td class="diff-marker"><a class="mw-diff-movedpara-left" title="Paragraph was moved. Click to jump to new location." href="#movedpara_0_0_rhs">&#x26AB;</a></td> <td class="diff-deletedline diff-side-deleted"><div><a name="movedpara_15_1_lhs"></a>[[Category:KDE3]]</div></td> <td colspan="2" class="diff-empty diff-side-added"></td> </tr> <tr> <td class="diff-marker"><a class="mw-diff-movedpara-left" title="Paragraph was moved. Click to jump to new location." href="#movedpara_2_0_rhs">&#x26AB;</a></td> <td class="diff-deletedline diff-side-deleted"><div><a name="movedpara_15_2_lhs"></a>[[Category:Architecture]]</div></td> <td colspan="2" class="diff-empty diff-side-added"></td> </tr> <tr> <td class="diff-marker"><a class="mw-diff-movedpara-left" title="Paragraph was moved. Click to jump to new location." href="#movedpara_2_1_rhs">&#x26AB;</a></td> <td class="diff-deletedline diff-side-deleted"><div><a name="movedpara_15_3_lhs"></a>[[Category:Developers]]</div></td> <td colspan="2" class="diff-empty diff-side-added"></td> </tr> <!-- diff cache key mwdb:diff:wikidiff2:1.12:old-273:rev-1686:1.13.0 --> </table>

Blu256 https://wiki.trinitydesktop.net/index.php?title=Doxygen_Documentation&diff=273&oldid=prev 2014-06-11T20:58:20Z

<p>Created page with &quot;== 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...&quot;</p> <p><b>New page</b></p><div>== Outdated Documentation is Dangerous ==<br /> <br /> The KDE team strives to provide documentation for the KDE programming<br /> interfaces and libraries that is always up-to-date and correct. Taking<br /> ideas from literate programming and &#039;&#039;Java&#039;&#039;, we decided from day<br /> one to keep the documentation as close to the source as possible.<br /> <br /> == Documentation and Source are Joined at the Hip ==<br /> <br /> All the KDE API documentation is contained within the library source<br /> itself. Documentation is written using specially-marked comments.<br /> This ensures that the latest library is always shipped with the latest<br /> documentation, and makes it easy for programmers to update and write<br /> documentation as the interface grows and changes.<br /> <br /> == Don&#039;t use the Source, Luke ==<br /> <br /> The KDE project uses [http://www.doxygen.org Doxygen], a tool to generate<br /> easily readable and heavily cross-referenced documentation in a variety of<br /> hypertext and printable formats. For an example of it&#039;s output, browse the [http://api.kde.org/3.5-api/kdelibs-apidocs/ KDE 3.5 API Reference].<br /> <br /> We also recommend that application developers use &#039;&#039;Doxygen&#039;&#039; while<br /> developing their applications, since it acts as a good reference for<br /> the developers themselves, or for anyone who wishes to modify or extend<br /> the application. Any non-trivial application benefits from an easily<br /> browseable and comprehensive API reference.<br /> <br /> For detailed information on how to use Doxygen, see the<br /> [http://www.doxygen.org Doxygen home page].<br /> <br /> <br /> &#039;&#039;Initial Author:&#039;&#039; [mailto:taj@kde.org Sirtaj Singh Kang]<br /> <br /> [[Category:KDE3]]<br /> [[Category:Architecture]]<br /> [[Category:Developers]]</div>

imported>Eliddell