Shell command projects/mkd
De Wiki EELL.
m (→Manuels / Manuals : Ajout de mkddocu manuele en français) |
m (→Manuel mkddocu en français : Mise à jour avec le manuel de mkddocu en anglais) |
||
| Ligne 662 : | Ligne 662 : | ||
11. Mai 2013 MKD(1) | 11. Mai 2013 MKD(1) | ||
| + | </pre> | ||
| + | |||
| + | {{Boîte déroulante/fin}} | ||
| + | |||
| + | === Manual mkddocu in english === | ||
| + | {{Boîte déroulante/début|titre=mkddocu Manual en (10 Mars 2014)}} | ||
| + | <pre style="color:white;background-color:black;"> | ||
| + | mkddocu(1) Linux User's Manual mkddocu(1) | ||
| + | |||
| + | NAME | ||
| + | mkddocu - This shell command generates the software documentations for all project | ||
| + | compatible with the software mkd. | ||
| + | |||
| + | SYNOPSIS | ||
| + | mkddocu [project] [-s] | ||
| + | |||
| + | DESCRIPTION | ||
| + | The command mkd linked to mkddocu, extracts the special comments marked by a benchmark | ||
| + | character. | ||
| + | Example : //D this is a php comment with a 'D' benchmark. | ||
| + | If some C files exist, then mkddocu will create a global header for the project, with | ||
| + | the benchmark character 'H'. | ||
| + | |||
| + | Benchmarks : | ||
| + | D - Extract the general documentation. | ||
| + | H - Extract comments from C files to create the global header file. | ||
| + | P - Creates the file useful for maintainers with General descriptions. | ||
| + | T - Creates the file useful for maintainers with the directives of tests. | ||
| + | |||
| + | OPTIONS | ||
| + | -project | ||
| + | This option allows to choose a project name which is different from the default | ||
| + | name, else the project name is 'project'. If 'project' is the character '?' the | ||
| + | command will show the syntax. | ||
| + | |||
| + | -s This option specifies that the command should create the strings file, and also | ||
| + | the file of strings useful for translate with gettext and poedit. | ||
| + | |||
| + | RETURN VALUE | ||
| + | 0 : End - when the command is complete or at the end of the help execution. (syntax) | ||
| + | -1 : mkd command is not found. | ||
| + | -2 : Command stopped. The backup is not performed. | ||
| + | |||
| + | EXAMPLES | ||
| + | The self-documentation of this command is created by the original file mkddocu.sh | ||
| + | Execute the command : 'mkddocu.sh mkddocu -s' | ||
| + | The directory maintenance/mkddocu contains the documents. | ||
| + | The directories of projects are generated by series and are stored in the directory | ||
| + | 'Backups' when the number of the series reaches the limit BACKUPSMAX | ||
| + | To test them, limit the value of BACKUPSMAX at 2. (3 backups by serie) | ||
| + | |||
| + | NOTES | ||
| + | BACKUPSMAX is normally fixed at 9 however you can modify this value by editing the file | ||
| + | /usr/bin/mkddocu. | ||
| + | |||
| + | SEE ALSO | ||
| + | mkd(1) xgettext(1) poedit(1) | ||
| + | |||
| + | DOWNLOADS | ||
| + | http://edeulo.free.fr | ||
| + | |||
| + | AUTHORS | ||
| + | Clara, JPL, Luca | ||
| + | Email : http://edeulo.free.fr/contacts/formmail.php | ||
| + | |||
| + | BUGS | ||
| + | Bug reports : http://edeulo.free.fr/phpBB3/viewforum.php?f=14 | ||
| + | |||
| + | 2014-02-24 mkddocu(1) | ||
</pre> | </pre> | ||
