Scroll to navigation

monodoc(1) General Commands Manual monodoc(1)

NAME

monodoc - GUI Mono documentation browser

SYNOPSIS

monodoc [options]

DESCRIPTION

monodoc is a GTK#-based browser for viewing collected API documentation for CLI libraries installed on the system

RUNTIME OPTIONS

The following options are available for browsing documentation:

Start the browser at TOPIC
(ex. N:System, T:System.Object, M:System.Object.Equals, and P: for properties, F: for fields, E: for events, etc.)
Print a brief instructions on usage
About the monodoc browser
Print the HTML contents of TOPIC
Create the documentation index
Create the searchable documentation index
Select a browser backend (Gecko, GtkHtml, WebKit, MonoWebBrowser)

The following options are available for authoring documentation:

Runs the doc assembler
Converts C# documentation to Monodoc format
Edit (unassembled) documentation at path
Prints the location of monodoc sources

--merge-changes CHANGE_FILE [TARGET_DIR]

Format a documentation file consistently
Validate the XML files

SEE ALSO

mono(1), mdassembler(1), mdcs2ecma(1), mdnormalizer(1), mdvalidator(1), monodocs2html(1), monodocer(1)