wiki:Doxygen

Génération de documentation à l'aide de Doxygen

vous pourrez trouver des informations à propos de "Doxygen"... avant goût :

Doxygen is a documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors), Fortran, VHDL, PHP, C#, and to some extent D.

It can help you in three ways:

  1. It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in $\mbox{\LaTeX}$) from a set of documented source files. There is also support for generating output in RTF (MS-Word), PostScript?, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code.
  2. You can configure doxygen to extract the code structure from undocumented source files. This is very useful to quickly find your way in large source distributions. You can also visualize the relations between the various elements by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically.
  3. You can even `abuse' doxygen for creating normal documentation (as I did for this manual).

Doxygen is developed under Linux and Mac OS X, but is set-up to be highly portable. As a result, it runs on most other Unix flavors as well. Furthermore, executables for Windows are available.

http://www.stack.nl/~dimitri/doxygen/index.html

I have a dream that one day, all the codes will be well documented...

Doxygen pour linux

Alors là, c'est simplissime... ça s'adresse au néophytes. Si vous êtes moins néophytes et que ceci vous parait trop simple, ajoutez des informations. Donc en quelque étapes :

  1. Installation de doxygen. Via synaptics, c'est très simple. On cherche doxy dans la barre de recherche, et on charge le paquet et sa doc.
  1. Installation de graphviz. même procédure via synaptics.
  1. Run doxygen
doxygen

Le code vous dira ce qu'il est possible de faire.

  1. création d'un template "Doxyfile", qui est le fichier de configuration de votre documentation.
    doxygen -g
    
  1. Etape la plus compliqué et la plus importante, l'édition de votre fichier de configuration. Lire et éditer le fichier au fur et à mesure.

l'option qui fait des graph est géniale...

  1. Relancer doxygen en prenant en compte votre configuration
    doxygen Doxyfile
    
  2. ouvrir la doc via le navigateur web (la documentation se trouve dans le répertoire que vous avez indiqué à l'étape 4)
  1. maintenant il ne reste plus qu'à documenter les fichiers sources... mais l'architecture du code est déjà bien plus lisible.

You had a dream yesterday...

some had it before and make your dream reality. Thanks to Dimitri Van Heesch.

Last modified 5 years ago Last modified on Jan 11, 2017 3:49:51 PM