adabrowse - En ligne dans le cloud

PROGRAMME:

Nom

adabrowse - Générer un rendu HTML entièrement référencé des spécifications Ada 95

SYNOPSIS

adaparcourir [options] -f filet

DESCRIPTION

adaparcourir produit un rendu HTML entièrement référencé des spécifications Ada 95 (sans corps)
similaire à ce que fait javadoc pour les sources Java. adaparcourir est un utilitaire de ligne de commande ; il a
pas d'interface utilisateur graphique.

adaparcourir est hautement configurable via des options de ligne de commande, des feuilles de style et
fichiers de configuration.

adaparcourir démonte complètement le code source et produit une documentation HTML
contenant:
· Toutes les clauses contextuelles
· En-tête de l'unité
· Si l'unité est un colis :
— Toutes les exceptions (y compris les renommages)
— Toutes les constantes
— Toutes les variables
— Un index de type contenant tous les types et leurs opérations primitives (ces dernières uniquement)
pour les types d'enregistrement (balisés), les types privés et les types dérivés de ceux-ci).
la liste des opérations primitives est entièrement référencée et ordonnée par nouvelle définition,
opérations remplacées et héritées.
— Tout autre élément

UTILISATION

Il y a deux façons d'utiliser adaparcourir:

1. Appel adaparcourir pour vos spécifications : adaparcourir -f filet (et toute autre option si nécessaire, dans
particulier -I si le fichier n'est pas dans le répertoire courant ou dépend d'autres unités
dont les sources ne sont pas dans le répertoire courant !) Si aucun fichier d'arborescence pour l'unité donnée
existe, adaparcourir je vais essayer d'en générer un.

or

1. Générez les fichiers arborescents pour les spécifications que vous souhaitez traiter en appelant moucheron -c -gnatc
-gnatt filet (avec les instructions appropriées) -I options, si nécessaire.)

2. Appel adaparcourir pour ces spécifications : adaparcourir -f filet (et toute autre option, selon les besoins)
[regardez en particulier -T!]).

adaparcourir génère des fichiers HTML par défaut dans le répertoire courant.

adaparcourir ne se soucie pas de savoir si les fichiers d'arborescence ont été produits à partir de spécifications ou de corps :
étant donné que le fichier arborescent d'un corps contient toujours également les informations sur la spécification, il peut
travailler avec l'un ou l'autre.

OPTIONS

-h, -?, -Aide, --Aidez-moi
Rédige un texte d’aide complet.

-a, -tout, --tout
Générer du HTML non seulement pour l'unité donnée dans l'option -f, mais aussi pour toutes
unités d'application dont il dépend sémantiquement (fermeture transitive de « avec »
et unités parentales).

Notez que cette option traite uniquement les unités d'application dans le transitif
fermeture même si l'option « -g » est également donnée ; elle ne traite aucun « avec »
unité de bibliothèque standard. Cela signifie également que si l'unité donnée est une unité de bibliothèque standard,
unité, l'option « -all » n'a aucun effet. Ce comportement est intentionnel : vous
génère normalement du HTML pour la bibliothèque standard une fois en traitant tous les standards
unités de bibliothèque explicitement, et vous ne souhaitez pas régénérer le HTML pour ces unités
à chaque fois qu'une de vos unités d'application "avec" une unité de bibliothèque standard.

-c filet
Définit un fichier de configuration pour le générateur HTML. Multiple -c les options peuvent être
donné ; les fichiers sont traités dans l'ordre donné et peuvent écraser la configuration précédente
paramètres.

-f filet
Indique le nom de fichier (*.ads) de la spécification à traiter. Ce nom de fichier peut contenir un
chemin ! Voir ci-dessous pour plus de commentaires. Un seul -f option peut être donnée.

-g Si défini, adaparcourir génère également des références croisées vers des éléments provenant d'unités de bibliothèque dans
les packages standard et d'exécution, à l'exception des éléments du package implicite
« Standard ». Remarque : cette valeur peut également être définie par une clé de fichier de configuration.
« Refs_To_Standard ». La dernière définition l'emporte.

-G formats_de_sortie...
Spécifier les formats de sortie adaparcourir générera. Le -G l'option doit être suivie
par un ou plusieurs noms de formats de sortie, donnés comme arguments distincts. Sortie reconnue
les noms de format sont html et xml (insensible à la casse).

-i [filet]
Si défini, adaparcourir générera un index de package s'il s'exécute en « mode d'entrée de fichier »
(voir ci-dessous) ou le -tout l'option est définie et la sortie ne va pas vers stdout.

Si un nom de fichier est donné, l'index est écrit dans ce fichier (ou sur stdout, si le
le nom du fichier est "-").

-is [filet]
Identique à -i, mais génère un index à l'aide de l'indentation pour les unités enfants.

-l Marque adaparcourir générer des références croisées dans la sortie HTML en utilisant uniquement le numéro de ligne.
C'est ce que les versions antérieures de adaparcourir (jusqu'à et y compris la V2.13) l'a toujours fait.
À partir de la version 3.0, les références croisées sont construites en tenant compte à la fois de la ligne et de la
Numéro de colonne d'un élément. N'utilisez cette option que si vous utilisez du HTML.
documentation générée par des précédents adaparcourir versions et ne peuvent en quelque sorte pas
générer cette documentation. Cependant, il est recommandé de ne jamais utiliser cette méthode.
option et de régénérer la documentation HTML éventuellement déjà existante.

Notez que le HTML généré avec -l n'est pas compatible avec le HTML généré sans -l!
De plus, HTML généré par adaparcourir 3.0 et au-delà sont compatibles avec le HTML généré
by adaparcourir 2.13 et versions antérieures uniquement si le -l option est donnée.

L'utilisation de cette option génère un message d'avertissement sur stderr.

-o [filet]
Définissez le nom du fichier de sortie. S'il n'est pas défini, la sortie sera dirigée vers un fichier portant le nom de
l'entrée et le suffixe .html. Si filet spécifie un répertoire (c'est-à-dire, se termine par un "\" sur
Windows ou un "/" sous Unix), tous les fichiers HTML générés seront placés dans ce
répertoire. Si le nom du fichier est « - », la sortie est écrite sur la sortie standard. Un seul -o option
peut être donnée.

Un tiret comme nom de fichier (« - ») n'est autorisé que s'il existe exactement un format de sortie
spécifié. Si plusieurs formats de sortie sont spécifiés (par exemple XML et HTML),
la sortie n'est pas autorisée à aller vers stdout.

-p [filet]
As -i, mais génère un index de sous-programme sur toutes les unités traitées.

-privé, --privé
Si donné, adaparcourir traitera également les parties privées des colis et des tâches ou
déclarations protégées. (Par défaut, il ne le fait pas mais remplace les déclarations privées
parties par un commentaire indiquant « Implémentation définie ».)

-q Mode silencieux : ne pas émettre de messages d'avertissement ou d'information. Synonyme de -w0.

-s URL Définit l'URL de la feuille de style que le fichier HTML généré doit utiliser. Cette URL
doit être relatif à l'emplacement final où vous placerez les fichiers HTML ! Notez que
a -s l'option peut être écrasée par une option ultérieure -c option, si le fichier de configuration
définit la clé "Style_Sheet".

-t [filet]
As -i, mais génère un index de type global sur toutes les unités traitées.

-version, --version
Informations sur la version imprimée de adaparcourir à stderr.

-wi Définit le niveau d'avertissement de adaparcourir. i peut être l'un des suivants :
0, ou e imprime uniquement les messages d'erreur.
1, ou w imprime les avertissements et les erreurs.
2, ou i, ou a imprime tous les messages.

-x Si défini, adaparcourir n'écrase jamais les fichiers HTML existants. (Peut être utile dans
conjonction avec le -a option.)

-X prénom=Plus-value
Définir une variable d'environnement prénom avec valeur Plus-value. La valeur remplace toute
définition peut-être déjà existante de prénom dans l'environnement du système pour cela
appeler pour adaparcourir. La nouvelle définition affecte tout fichier de configuration traité
par la suite ainsi que le dossier de projet (le cas échéant). prénom ne doit pas contenir de blanc
espace; si Plus-value contient un espace blanc, citez la définition entière comme dans -X"user=John
"Doe". Il peut y avoir ou non un espace blanc entre les -X et la variable
définition.

-I annuaire
Définir les chemins sources pour ASIS. Même sémantique que pour GNAT. Multiples. -I les options peuvent
être donné.

-T annuaire
Définir les chemins d'accès pour qu'ASIS recherche les fichiers d'arborescence (*.adt). Plusieurs -T les options peuvent être
donné.

Notez que si vous donnez un nom de fichier au -i option qui commence par la lettre « s »,
vous devez avoir un espace blanc entre l'option et le nom du fichier, sinon il sera
être reconnu comme un -is option. De plus, si le nom de fichier commence par « - », il ne doit pas
être un espace entre l'option et le nom du fichier, car s'il y en a, adaparcourir
supposera que le nom de fichier est l'option suivante et le traitera comme tel (options toutes
commencer par "-"), et non comme un nom de fichier.

La même mise en garde s’applique également à la -p option, si vous souhaitez que l'index du sous-programme
allez dans un fichier nommé « private » : il doit y avoir un espace vide, sinon, tout va
être reconnu comme le -privé option. (Certes, c'est une option plutôt pathologique
cas, mais il est mentionné ici pour être complet.)

THE -f OPTION

Le manuel de formation -f L'option a trois formats différents :

1. Si le nom du fichier est « - » ou « @- », adaparcourir lit les spécifications des unités à traiter
depuis l'entrée standard, une unité par ligne, jusqu'à ce que la fin du fichier soit rencontrée. Les lignes vides sont ignorées. (Si
Si vous essayez ceci de manière interactive, vous devrez signaler EOF vous-même. Sinon, cela risque d'être
utile si l'entrée provient d'un tube, comme dans « ls -1 *.ads | adabrowse -f- ... »)

2. Si le nom du fichier commence par « @ », adaparcourir ne le considère pas comme une spécification d'unité, mais comme le
Nom d'un fichier texte à partir duquel lire les noms d'unités, une unité par ligne. Lignes vides.
dans le fichier sont ignorés.

3. Si aucune de ces conditions ne s'applique, adaparcourir utilise le nom de fichier donné comme spécification d'unité.

Les deux premiers cas sont appelés le « mode d'entrée de fichier » de adaparcourir. Le fichier peut contenir
lignes vides et commentaires (commençant par le premier « # » sur une ligne et s'étendant jusqu'au
(fin de ligne), qui sont ignorés. Notez que contrairement aux fichiers de configuration, les chaînes
la gestion de la recherche des débuts de commentaires n'est pas effectuée, et les continuations de ligne ne le sont pas non plus
autorisé.

Dans les trois cas, une spécification d'unité est un nom de fichier qui peut contenir un chemin ; un suffixe possible
est ignoré. Notez qu'une spécification d'unité est un nom de fichier ; autrement dit, vous donnez test-gen, ou
test-gen.ads, et pas Test.GenLa raison est simplement que pour la plupart des scripts shell
langues, il est plus facile de travailler avec des noms de fichiers que de les transformer en noms d'unités (par exemple
en remplaçant les tirets par des points). De plus, si vous avez des noms de fichiers compressés, il n'y a pas de solution simple.
lien entre le nom du fichier et le nom de l'unité.

Si une spécification d'unité contient un chemin, le fichier HTML de cette unité est placé dans ce répertoire
à moins qu'il ne soit annulé par un -o option. Notez que si la spécification de l'unité contient un chemin, vous devrez probablement
il faudra probablement aussi définir un -T or -I option, à moins que vous n'ayez l'ASIS
informations disponibles directement (c'est-à-dire un fichier arborescent pour l'unité dans le répertoire courant ;
mais ce n'est pas exactement typique).

En mode de saisie de fichier, le -o l'option (si elle est donnée) peut être soit « - » (auquel cas toutes les
la sortie va vers stdout) ou spécifie un répertoire, mais ne doit pas spécifier un fichier.

adaparcourir suppose un schéma de nommage de type GNAT pour les fichiers source et HTML. Il suppose également
qu'il y a une unité de bibliothèque par fichier. À partir de la version 1.4, adaparcourir peut gérer les fichiers compressés
noms dans le -f option, à condition qu'il puisse trouver un fichier source et qu'il ait l'extension .les publicités.
Si tel est bien le cas, adaparcourir ouvre et analyse le fichier source pour extraire le nom de l'unité, au lieu de
en le dérivant directement du nom du fichier. Notez que les fichiers générés ont toujours des noms basés sur
sur le nom de l'unité, et non sur le nom du fichier d'origine : c'est-à-dire que les noms des fichiers de sortie ne seront jamais
craqué.

Les fichiers HTML générés ont toujours le suffixe « .html » (et non « .htm »).

INDEX GÉNÉRATION

La génération d'index est active lorsque adaparcourir est chargé de traiter plusieurs unités, et la sortie
ne va pas sur stdout (quand le -O- (l'option a été donnée).

Il existe plusieurs options contrôlant la génération d’index :

-i or -is Active la génération d'un index d'unité.
-p Active la génération d'un index de sous-programme.
-t Active la génération d'un index de type.

Toutes ces options prennent un nom de fichier facultatif comme paramètre. Si un nom de fichier suit, le
L'index sera écrit dans ce fichier (ou sur la sortie standard, si le nom du fichier est « - »). Si
aucun nom de fichier n'est donné, un nom par défaut est choisi.

Toutes ces options sont en fait conservées uniquement pour des raisons de compatibilité ascendante.
V4.0, les indices sont définis principalement via les entrées du fichier de configuration, et non via la commande
ligne. Afin de ne pas endommager les scripts existants en utilisant les options de ligne de commande des versions précédentes,
adaparcourir versions, ces options sont toujours disponibles.

adaparcourir suppose qu'il traitera plusieurs unités dans les cas suivants :
· En mode de saisie de fichier (-f @file_name or -F-).
· Lors de l'utilisation d'un fichier de projet (-P nom_fichier_projet).
· Quand le -tout option est donnée.

Si aucun nom de fichier n'est donné ou s'il ne contient pas de chemin, cela dépend du paramètre de
autres options où l'index sera placé :
· En mode de saisie de fichier, si un -o Si l'option est donnée, elle doit spécifier un répertoire. Tout HTML
les fichiers, y compris l'index, seront placés dans ce répertoire.
· Sinon -o l'option est donnée, mais la première spécification d'unité contient un chemin, l'index est mis
dans le répertoire désigné par ce chemin.
· Si vous n'êtes pas en mode de saisie de fichier, mais que l'option -all a été donnée, le -o l'option peut
Spécifiez un nom de fichier. L'index est placé dans le répertoire désigné par le chemin.
de ce nom de fichier (le répertoire courant, si le nom de fichier ne contient pas de chemin).
· Si vous utilisez un fichier de projet, les indices sont écrits dans le répertoire ADABROWSE_OUTPUT.
· Sinon, cet index est placé dans le répertoire courant.

Si un nom de fichier contenant un chemin est donné, l'index sera placé dans ce fichier dans le
répertoire donné. Si le nom de fichier ne contient qu'un chemin, adaparcourir utilisera ce chemin et
créer un index nommé « index.html » dans le répertoire désigné.

Si un -x l'option est donnée (empêchant l'écrasement des fichiers HTML existants) et un fichier existe
déjà à l'endroit où adaparcourir veut mettre l'index, aucun index ne sera généré
et adaparcourir émettra un avertissement. Il avertira également s'il ne peut pas générer d'index pour une
pour d'autres raisons, mais poursuivra le traitement.

Utilisez Adabrowse en ligne avec les services onworks.net