Le contrôle de Doxygen de LaTeX de sortie pour la fabrication de documents au format PDF
Je suis Doxygen pour générer la documentation pour mon code. J'ai besoin de faire une version PDF de ce et Doxygen de LaTeX de sortie semble être la façon de le faire.
Cependant, je ai couru dans un certain nombre de problèmes gênants, et ne rien savoir sur LaTeX précédemment n'ai pas vraiment eu beaucoup d'idée sur la manière de les approcher, et les innombrables références pour le LaTeX, les choses ne sont pas beaucoup vous aider...
J'ai travaillé sur la façon de créer un style personnalisé chose dans un sty fichier et comment l'obtenir Doxygen pour l'utiliser. Après beaucoup de recherche j'ai trouvé comment définir les marges de page, etc. grâce à cela, et je devine que la peut-être que c'est le fichier que je veux pour faire les autres choses que je veux, mais je ne peux pas l'air de trouver toutes les commandes pour doign ce que je veux 🙁
- La table des matières au début du document contient un grand nombre d'éléments Id plutôt qu'il ne l'a pas, car il rend le contenu très longtemps. Est-il un moyen de limiter ce contenu juste dire que les deux premiers niveaux, plutôt que d'avoir des entrées pour chaque individu de la fonction, variable, etc.? Id aime bien garder tous les signets. J'ai essayé la "COMPACT_LATEX" option mais en tant que bien que de supprimer des éléments sur le contenu des pages, elle a enlevé les signets et les listes de membres au début de chaque section, ce que je ne veux vraiment la garder.
- Est-il un moyen de changer l'ordre des choses, comme mettre le complet description de la classe au début de l'article, plutôt que d'après tous les membres et les attributs?
OriginalL'auteur Fire Lancer | 2010-02-28
Vous devez vous connecter pour publier un commentaire.
Wow, c'est le genre de mal de Doxygen.
D'accord, pour contourner la
tocdepth
problème de compteur, ajoutez la ligne suivante à votre.sty
fichier:Vous pouvez définir des signets PDF de la profondeur à une valeur distincte:
Notez également que si vous avez une liste de chiffres, de tableaux, la
tocdepth
doit être au moins 2 pour eux de montrer.Je ne vois pas de moyen de réorganiser les éléments dans les fichiers LaTeX---Doxygen juste barfs là-bas, donc on ne peut pas faire grand chose. Vous aurez à fouiller la documentation Doxygen pour voir si il y a moyen de spécifier l'ordre, je suppose. (J'espère!)
OriginalL'auteur godbyk
Vous êtes donc fermer.
Googling "latex le niveau du contenu" m'a amené à LaTeX - personnalisation de la profondeur de la table des matières pour les différentes parties de la thèse qui suggère
où
n
commence à zéro pour seulement le plus haut niveau de la division. C'est présumable défini dans tous les styles par défaut, mais vaut la peine d'essayer de doxygen.IL affecte également la profondeur de signets, id tiens à garder, si possible, car l'arborescence réductible rend plus adapté pour la liste complète. Mais tout ce que j'ai trouvé semble traiter de la même manière 🙁
Beaucoup d'entre nous qui utilisent LaTeX pour la documentation d'utilisation font de fichiers pour le contrôle de la publication, avec des scripts personnalisés de faire des morceaux de sed et awk (et autres services publics) à faire le genre de montage que vous décrivez. Bien sûr, beaucoup d'entre nous sont long-temps Unix/Linux les utilisateurs pour qui c'est aussi naturel que la respiration et l'approche peut ne pas convenir à vos besoins ou à l'arrière-plan.
Je suis désolé, ça ne le fait pas. Je suis hors de conseils.
Vous devez copier le doxygen.sty fichier que vous avez modifié dans l' /latex répertoire après l'exécution de doxygen. Au moins sur mon installation, il re-génère ce fichier avec les valeurs par défaut chaque fois que vous exécutez doxygen.
OriginalL'auteur dmckee
Vous pourriez écrire un Perl/script Awk pour simplement supprimer les lignes indésirables à partir de la table des matières. Pour le fichier
burble.tex
, Latex va générer le fichierburble.toc
, qui contiendra des lignes telles que:Simple regexes permettra d'identifier les niveaux de chaque ligne appartient, et vous pouvez filtrer les fichiers sur cette base. Une fois que vous avez la table des matières la façon dont vous le souhaitez, insérer
\nofiles
à l'endroit approprié (la feuille de style?), ce qui signifie que le Latex va lire les fichiers auxiliaires, mais pas les remplacer.OriginalL'auteur Charles Stewart