User Tools

Site Tools


geda:devel-tips

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
geda:devel-tips [2012/10/25 02:42]
vzh Fixed a directory name + automatic trailing spaces deletion
geda:devel-tips [2014/04/18 11:25]
vzh Add link to Russian translation
Line 1: Line 1:
 +//​Translations of this page are also available in the following languages://​ [[devel-tips.ru|Русский]].
 +
 ====== gEDA Developer Tips, tricks and hints ====== ====== gEDA Developer Tips, tricks and hints ======
  
Line 18: Line 20:
 Some sections of the gaf source have already been doxyfied. Currently, this includes libgeda, gschem, gnetlist, gsymcheck and gattrib. The Makefile in the //docs// dir of these tools contains a target "​doxygen"​. Alternatively,​ you can browse the output of doxygen online [[http://​www.xs4all.nl/​~ljh4timm/​gaf/​dox.html|on this site]], made available by Bert Timmerman. Some sections of the gaf source have already been doxyfied. Currently, this includes libgeda, gschem, gnetlist, gsymcheck and gattrib. The Makefile in the //docs// dir of these tools contains a target "​doxygen"​. Alternatively,​ you can browse the output of doxygen online [[http://​www.xs4all.nl/​~ljh4timm/​gaf/​dox.html|on this site]], made available by Bert Timmerman.
  
-If you want to see Doxygen'​s ideas on how to format documentation see the [[http://​www.stack.nl/​~dimitri/​doxygen/​docblocks.html|Doxygen website]]. The individual commands are documented [[http://​www.stack.nl/​~dimitri/​doxygen/​commands.html|here]]. There is also a very handy Doxygen [[http://​www.digilife.be/​quickreferences/​QRC/​Doxygen%20Quick%20Reference.pdf|quick reference card]].+If you want to see Doxygen'​s ideas on how to format documentation see the [[http://​www.stack.nl/​~dimitri/​doxygen/​docblocks.html|Doxygen website]]. The individual commands are documented [[http://​www.stack.nl/​~dimitri/​doxygen/​commands.html|here]]. There is also a very handy Doxygen [[http://​www.digilife.be/​quickreferences/​QRC/​Doxygen ​Quick Reference.pdf|quick reference card]].
  
 The following sections provide an introduction on how gschem and libgeda are customarily documented. Note that the QT style of **%%/*! comment goes here */%%** for a Doxygen-enabled comment is preferred. The following sections provide an introduction on how gschem and libgeda are customarily documented. Note that the QT style of **%%/*! comment goes here */%%** for a Doxygen-enabled comment is preferred.
geda/devel-tips.txt · Last modified: 2014/04/18 11:25 by vzh