mdassembler - Online in the Cloud

PROGRAMME:

Nom

mdassembler - Compile documentation for use in monodoc browser

SYNOPSIS

mdassembleur OPTIONS* DIRS+

DESCRIPTION

mdassembleur a été obsolète par mdoc(1). Voir le mdoc-assembler(1) page de manuel.

mdassembleur is a program that creates .arbre et .zip files for use in the monodoc
navigateur de documentation.

Le manuel de formation .arbre et .zip files are copied into monodoc's sources directory, and reside with a
.la source fichier qui est utilisé par monodoc to specify where the documentation should be
affiché. Les .la source des dossiers /monodoc/source/@basefile attribute specifies the filename
prefix for the documentation files. This must be the same prefix as used with the --dehors
paramètre.

OPTIONS

--ecma The documentation found within DIR is in the Mono ECMA documentation format. See
le Mono ECMA Documentation Format section ci-dessous.

--ecmaspec
The documentation found within DIR is in the ECMA Specification documentation
format. See the Mono ECMA Spécifications Documentation Format section ci-dessous.

--Erreur
The documentation found within DIR is in "error" format. See the Erreur
Documentation Format section ci-dessous.

--Aidez-moi Afficher les informations sur les arguments du programme.

--homme The documentation found within DIR is in man page format. See the Homme Page
Documentation Format section ci-dessous.

-o, --dehors PRÉFIXE
Spécifiez le préfixe du fichier de sortie. mdassembleur crée les fichiers PREFIXE.zip et
PREFIX.arbre .

--Facile
The documentation found within DIR is in "simple" format. See the Simple
Documentation Format section ci-dessous.

--xhtml, --hb
The documentation found within DIR is in XHTML format. See the XHTML
Documentation Format section ci-dessous.

FORMATS

Les formats de documentation suivants sont pris en charge :

Mono ECMA Documentation Format
An XML documentation format with one file per type.

Voir le mdoc(5) page de manuel pour plus d'informations.

Mono ECMA Spécifications Documentation Format
This is not the format you're looking for.

This is the format used to represent the ECMA-334 (C#) standard within monodoc. Ce n'est pas
used to display class library documentation; for class library documentation, use the
--ecma le format.

Erreur Documentation Format
Used to present detailed error messages, and is used in monodoc's "C# Compiler Error
Reference" tree. DIR is not a directory, but is instead a configuration file, containing
the XML:


../../mcs/erreurs
cs ????*.cs
2
4
CS{0:0###}


/ErrorProviderConfig/FilesPath specifies where to look for files,
/ErrorProviderConfig/Match specifies the filename pattern to look for within
/ErrorProviderConfig/FilesPath, /ErrorProviderConfig/ErrorNumSubstringStart et
/ErrorProviderConfig/ErrorNumSubstringLength control which portion of the filename is used
as the error number, and /ErrorProviderConfig/FriendlyFormatString contrôle la façon dont le
formatting/display of the node in the monodoc arbre.

Pour chaque fichier trouvé, il est converti en HTML avec la coloration de la syntaxe C# appliquée.

Simple Documentation Format
Converts text files into HTML by translating each newline into an HTML <br> .

Homme Page Documentation Format
Converts man pages into HTML for display.

XHTML Documentation Format
Copies the XHTML file as-is.

EXEMPLES

To install your documenation for use with monodoc:

Créer a PREFIX.source filet
avec le contenu:

<? Xml version = "1.0"?>

<source provider="FORMAT" basefile="PREFIX" path="PATH"/>


where FORMAT is the documentation format contained within the PREFIX.arbre fichier,
par exemple ecma, ou simple. PRÉFIXE is le nom de base of le .arbre et .zip fichiers qui
mdassembleur crée. PATH is the "path" in the monodoc tree that should contain
the documentation. See the @prefix@/lib/monodoc/monodoc.xml fichier pour une liste de
PATH values (the //noeud/@nom valeurs).

Voir aussi: http://www.mono-
project.com/docs/tools+libraries/tools/monodoc/generating-documentation/

Créer votre Documentation
Voir aussi monodocteur(1) man page, e.g.

monodocer -assembly:foo.dll -path:foo/en

Assembler le Documentation

mdassembler --ecma foo/en PREFIX

Make sure that you use the same PRÉFIXE here as you did above.

Installer le Documentation by grâce à le commander

cp PREFIX.source PREFIX.tree PREFIX.zip \
`pkg-config monodoc --variable=répsources`

(Note the backticks used in the pkg-config command!) This copies the .la source ,
.arbre et .zip fichiers dans le monodoc sources directory, which will allow monodoc
to display the documentation.

Use mdassembler online using onworks.net services