cxref - En ligne dans le cloud

PROGRAMME:

Nom

cxref - Outil de référencement croisé et de documentation C.

SYNOPSIS

cxréf nom de fichier [ nom de fichier] [-Odis-moi] [-Nnom de base] [-Rnom de base] [-tous les commentaires]
[-Sans commentaires] [-verbatim-commentaires] [-block-commentaires]
[-xref[-all][-file][-func][-var][-type]] [-warn[-all][-comment][-xref]]
[-index[-all][-file][-func][-var][-type]] [-brut] [-latex] [-html[-src]] [-rtf] [-sgml]
[-JEdis-moi] [-RÉVous permet de définir] [-UVous permet de définir] [-RPC programme_cpp] [-- cpp_args cpp_args]

cxréf nom de fichier [ nom de fichier] -effacer [-Odis-moi] [-Nnom de base] [-Rnom de base]

DESCRIPTION

Un programme qui peut générer automatiquement de la documentation et des références croisées pour un C
.

L'entrée est n'importe quel programme C avec les commentaires appropriés et la sortie est LaTeX, HTML, RTF ou
Fichiers SGML.

OPTIONS

nom de fichier
Le nom du fichier à documenter, n'importe quel nombre de fichiers peut être documenté à la fois.

-effacer
Les fichiers nommés doivent être supprimés du répertoire de sortie et leurs entrées dans
la base de données de références croisées et les principaux fichiers de sortie doivent être supprimés.

-Odirnom
Le nom d'un répertoire à utiliser pour les fichiers latex de sortie et l'emplacement du
fichiers de références croisées créés.

-Nnom de base
Le nom à utiliser pour la première partie des fichiers de sortie et de références croisées
de cxref, les extensions de fichiers restent les mêmes.

-Rdirname
Lorsque les fichiers source se trouvent dans plusieurs répertoires, définissez dirname sur le nom de
le répertoire racine de l'arborescence source (utilisez le chemin relatif si c'est plus facile, par exemple `-R../ ..').
Cela exécutera alors cxref à partir de ce répertoire racine et le `-Odirname' doit être
par rapport à ce répertoire.

-tous les commentaires
Si vous pensez que les commentaires existants pourraient fonctionner (voir ci-dessus pour la description)
de commentaires particuliers). [Danger! Cette option peut produire des résultats étranges.]

-Sans commentaires
Ignore tous les commentaires, utile si vous souhaitez uniquement les références croisées et non les
Documentation.

-commentaires-verbatim
Lorsque les commentaires que vous avez dans le code sont formatés dans un style prédéterminé
que vous souhaitez conserver sur la sortie, cette option les obligera à ne pas être
reformaté. [Remarque : ceci concerne uniquement les commentaires sur les fichiers et les fonctions.]

-bloquer-les commentaires
Lorsque les commentaires du programme sont formatés dans le style « bloc » (avec un début
caractère '*' sur chaque ligne), cette option supprimera ce caractère du
sortir. [Fonctionne pour un seul `*', `+', `|' ou `:' sur chaque ligne.]

-xréf Produire des informations de référencement croisé (voir ci-dessous).
-all Toutes les références croisées.
-file Références croisées pour les fichiers.
-func Références croisées pour les fonctions.
-var Références croisées pour les variables.
-type Références croisées pour les types.

-avertir Produire des avertissements, les options doivent être concaténées entre elles :
-all Tous les avertissements.
-comment Avertir des commentaires manquants.
-xref Avertir des références croisées manquantes.

-indice Produire un index de références croisées, les options doivent être concaténées entre elles :
-all Tous les index.
-file Index des fichiers.
-func Index des fonctions.
-var Index des variables.
-type Index des types.

-cru Produire une forme de sortie brute, pas vraiment d'une grande utilité sauf avec -warn.

-latex Produire un fichier LaTeX pour documenter chacun des fichiers sources ainsi qu'un fichier supplémentaire
qui inclut chacun de ces fichiers.

-html Produire un fichier HTML 4.01 pour documenter chacun des fichiers sources et un fichier principal pour
référencer chacun de ces fichiers.

-html-src
Produisez la sortie HTML et une version HTML du fichier source avec des liens vers celui-ci.

-rtf Produisez un fichier Rich Text Format (RTF) pour documenter le fichier source.

-sgml Produisez un fichier SGML pour documenter le fichier source. (En utilisant la DTD LinuxDoc).

-Idirname
Option GCC pour spécifier le chemin des fichiers à inclure.

-Définir
Option GCC pour définir un symbole de pré-processeur.

-Udéfinir
Option GCC pour annuler la définition d'un symbole de pré-processeur.

-RPC Danse
Le nom du programme à utiliser à la place de la valeur par défaut au moment de la compilation. Le programme
doit être capable d'effectuer toutes les actions que `gcc -E -C -dD' fait pour fonctionner. Si
le programme prend des arguments alors le tout doit être entre guillemets pour qu'il
est interprété comme un argument unique pour cxref.

--arg arg
Les arguments supplémentaires à transmettre au pré-processeur peuvent être placés après le `--'
séparateur.

C Compilateur après extraction cxref-cc
Pour simplifier l'utilisation de cxref sur le code source existant, il existe désormais un script shell qui
appelez le compilateur C, puis appelez cxref pour traiter le fichier source. Cela signifie qu'il
peut être utilisé en remplacement de CC dans les Makefiles et autres.

Utilisation : cxref-cc [options cc habituelles]

Le nom du fichier source est extrait de la liste des options ainsi que le `-D*',
Les indicateurs `-I*', `-U*' et lorsque le compilateur C se termine avec succès, cxref sera appelé. Le
le nom du compilateur C à utiliser est contrôlé par la variable d'environnement CXREFCC, ou si
ceci n'est pas défini alors la variable d'environnement CC, ou à défaut simplement gcc.

L'utilisation de ce script nécessite l'utilisation d'un fichier de configuration `.cxref' pour contenir les options
puisqu'il n'y a nulle part où mettre les options sur la ligne de commande du compilateur C.

Cela ne fera que croiser et documenter les fichiers source C puisqu'ils sont les seuls
ceux qui sont compilés, mais il veillera à ce qu'ils soient référencés avec les
options correctes, etc.

Cxréf configuration Déposez votre dernière attestation
Ces arguments de ligne de commande peuvent également être placés dans un fichier nommé « .cxref » au lieu de
ligne de commande. Lorsque cxref est exécuté, les arguments du programme sont interprétés dans le format
ordre suivant.

(1) Ceux sur la ligne de commande. (2) Ceux du fichier `.cxref' du répertoire courant.
(3) Ceux du fichier `.cxref' dans la racine de l'arborescence source spécifiée par `-R'.

Cela signifie que dans une arborescence source multi-répertoires, chaque sous-répertoire peut avoir un `.cxref'
fichier contenant uniquement la ligne `-R..' ou appropriée. Le répertoire principal peut avoir un
Fichier `.cxref' contenant le reste des options. Cela supprime complètement le besoin
pour avoir des options sur la ligne de commande en dehors des noms de fichiers source.

Le format du fichier `.cxref' est un nombre quelconque de lignes, chacune contenant un seul
argument de ligne de commande (équivalent à l’un des argv). Les seules options qui ne peuvent pas être
les noms des fichiers sources eux-mêmes et l'option `-delete' sont utilisés. Les lignes vides sont
ignoré et les lignes commençant par un « # » sont des commentaires.

Programme Documentation Commentaires
La documentation du programme est produite à partir des commentaires dans le code qui sont
formaté de manière appropriée. Les références croisées proviennent du code lui-même et ne nécessitent aucun
travail supplémentaire.

Les commentaires spéciaux sont `/**** ****/' (pour un fichier) et `/*++++ ++++*/' (pour un fichier de données).
objet) n'importe quel nombre de `*' ou `+' peut être utilisé à l'intérieur du commentaire standard `/*' et `*/'
délimiteurs dans les commentaires, ils sont ignorés.

Si une ligne de commentaire commence par un espace et est suivie de `+html+' alors le reste du
la ligne est incluse uniquement dans la sortie HTML et n'est pas traitée afin qu'elle puisse inclure du HTML
balisage, `-html-' signifie que le reste de la ligne est inclus dans tout sauf le HTML
sortir. La même chose s'applique également aux autres formats de sortie, `+aucun+' peut être utilisé pour les lignes
ne doit apparaître dans aucune sortie. L'exception à ceci est que la sortie brute ne fait rien
vérification et affichera toutes les lignes.

Dans toute situation où un commentaire suit un `,', `;' ou `)' séparés uniquement par des espaces et
onglets, le commentaire est poussé avant la ponctuation pour s'appliquer à l'objet qui s'y trouve.

Le programme est implémenté à l'aide d'un analyseur de grammaire ANSI C complet avec quelques extensions GCC,
cela signifie que le style du code n'a pas d'importance, seuls le contenu et les commentaires sont importants.

Cross Référencement
Le référencement croisé est effectué pour les éléments suivants

Fichiers
Les fichiers dans lesquels le fichier actuel est inclus
(même lorsqu'il est inclus via d'autres fichiers).

#comprend
Fichiers inclus dans le fichier actuel.
Fichiers inclus par ces fichiers, etc.

Variables
L'emplacement de la définition des variables externes.
Les fichiers qui ont une visibilité sur les variables globales.
Les fichiers/fonctions qui utilisent la variable.

Les fonctions
Le fichier dans lequel la fonction est prototypée.
Les fonctions que la fonction appelle.
Les fonctions qui appellent la fonction.
Les fichiers et fonctions qui font référence à la fonction.
Les variables utilisées dans la fonction.

Chacun de ces éléments est référencé dans la sortie.

Les références croisées utilisent les fichiers `cxref.variable', `cxref.function', `cxref.include' et
`cxref.typedef' dans le répertoire de sortie. Voici une liste complète des fonctions et
utilisation variable dans le programme et pourrait être utilisé pour générer une hiérarchie d'appels de fonction ou
diagramme d'utilisation variable par exemple. Deux passes de référence cxref de chaque fichier sont nécessaires, la première à
constituer les fichiers de références croisées et le second de les utiliser.

(Les noms de fichiers sont différents si l'option `-N' est utilisée.)

Latex Sortie
La sortie LaTeX par défaut est un fichier pour chacun des fichiers source avec un fichier supplémentaire
`cxref.tex' qui inclut chacun des autres fichiers. Ceci permet à un makefile uniquement
mettre à jour les fichiers modifiés (bien que les références puissent exiger que tous les fichiers soient
vérifié à nouveau). Une fois le fichier cxref.tex écrit, il peut être modifié par l'utilisateur,
tous les nouveaux fichiers ajoutés sont ajoutés à la fin de la section du code source, le reste de
le fichier étant inchangé.

L'index est écrit dans un fichier appelé « cxref.apdx.tex » et cxref.tex est mis à jour pour faire référence
à elle.

Sont également écrits trois fichiers de style LaTeX `page.sty', `fonts.sty' et `cxref.sty'.
Ceux-ci configurent la page pour qu'elle utilise une marge plus petite et des polices plus petites pour permettre à davantage d'apparaître sur
une page et définissez également les nouvelles commandes de composition de la sortie cxref.

(Les noms de fichiers « cxref.tex » et « cxref.apdx.tex » sont différents si l'option « -N » est
utilisé.)

HTML Sortie
La sortie HTML par défaut est un fichier pour chacun des fichiers source avec un fichier supplémentaire
`cxref.html' qui inclut chacun des autres fichiers. Ceci permet à un makefile uniquement
mettre à jour les fichiers modifiés (bien que les références puissent exiger que tous les fichiers soient
vérifié à nouveau). Une fois le fichier cxref.html écrit, il peut être modifié par l'utilisateur,
tous les nouveaux fichiers ajoutés sont ajoutés à la fin avant la table des matières, le reste
du fichier étant inchangé.

L'index est écrit dans un fichier appelé « cxref.apdx.html » et cxref.html est mis à jour pour faire référence
à elle.

(Les noms de fichiers « cxref.html » et « cxref.apdx.html » sont différents si l'option « -N » est
utilisé.)

La sortie HTML utilise la norme HTML 4.01 et toutes les pages sont correctement validées.

RTF Sortie
Rich Text Format est un format de description de page de niveau assez bas conçu par Microsoft. Il
n'est pas une norme bien définie et facile à comprendre comme le sont les autres formats, mais c'est
populaire pour l'échange de documents.

Il existe un seul fichier de sortie pour chacun des fichiers source et un fichier d'index.

SGML Sortie
Puisque SGML est un métalangage, il est nécessaire de définir les éléments de mise en page ainsi que
fournir les informations. La sortie cxref utilise le format de document LinuxDoc et est
conçu pour être utilisé avec les programmes SGMLtools (http://www.sgmltools.org/).

Il existe un seul fichier de sortie pour chacun des fichiers source et un fichier d'index.

Utilisez cxref en ligne à l'aide des services onworks.net