Il s'agit de la commande src2man qui peut être exécutée dans le fournisseur d'hébergement gratuit OnWorks en utilisant l'un de nos multiples postes de travail en ligne gratuits tels que Ubuntu Online, Fedora Online, l'émulateur en ligne Windows ou l'émulateur en ligne MAC OS
PROGRAMME:
Nom
src2man - extraire les pages de manuel des fichiers source.
SYNOPSIS
src2man [-n][-d Date][-v le volume][-r libérer] [fichier src ...]
DESCRIPTION
src2man analyse le fichier source fichier src. Seuls les fichiers source C sont pris en charge pour le moment. commentaires
les blocs commençant par "/** num", où num est un numéro de section, sont convertis en man
fichier, utilisation txt2man (1).
La première ligne du bloc de commentaire doit contenir le nom de la page de manuel, généralement le
nom de la fonction, suivi d'un "-" et d'une brève description. Les lignes suivantes sont les
Contenu de la section "DESCRIPTION", sauf s'ils sont en majuscules, auquel cas ils définissent
une nouvelle rubrique.
Si la ligne suivante après un bloc de commentaire est vide, alors aucune section "SYNOPSIS" ne sera
généré. Autrement, src2man cherchera dans les lignes sources suivantes une fonction
prototype ou une définition de type (struct, union, typedef, ...) correspondant au nom de la page de manuel, et
l'inclure dans une section "SYNOPSIS". Cela évite de dupliquer le type ou la fonction
prototype dans le bloc de commentaire.
Le meilleur endroit pour la documentation du code est dans le fichier source, où le corps est
implémenté, pas le fichier d'en-tête qui ne contient que le prototype. src2man automatiquement
recherche la présence d'un prototype dans le fichier d'en-tête correspondant, et s'il le trouve,
affichera une instruction "#include" dans le synopsis.
OPTIONS
-d données
Définissez la date des pages de manuel. La valeur par défaut est la date du jour.
-n Aucune page de manuel n'est créée. Le nom des pages de manuel qui seraient créées est imprimé.
-v le volume
Spécifiez le nom du volume à imprimer dans l'en-tête central de généré
pages de manuel.
-r libérer
Spécifiez le nom du projet et libérer numéro de la page de manuel générée.
EXEMPLE
L'exemple suivant affiche le code C et les commentaires pour générer une page de manuel foobar.3 :
/** 3
* foobar - un exemple de fonction factice
* Cette ligne est maintenant la première de la section description.
* Notez que les paramètres de fonction parm1 et parm2 sont mis en évidence
* dans la page de manuel générée.
*/
int foobar(char *parm1, int parm2)
{
...
0 revenir;
}
Utilisez src2man en ligne en utilisant les services onworks.net
