diff options
author | Jonathan Pryor <jpryor@novell.com> | 2009-04-10 06:06:01 +0400 |
---|---|---|
committer | Jonathan Pryor <jpryor@novell.com> | 2009-04-10 06:06:01 +0400 |
commit | 6166db125b24d7e617c733297dca893ffa425059 (patch) | |
tree | 57d866ab9d1e30d65aa0b90d474288ebd1a21681 /man/mdoc-update.1 | |
parent | e6e5024d269af46f4dd58aec5ce86b45061aaa4f (diff) |
* mdoc-update.1: Document -L, -r options.
svn path=/trunk/mono/; revision=131449
Diffstat (limited to 'man/mdoc-update.1')
-rw-r--r-- | man/mdoc-update.1 | 17 |
1 files changed, 13 insertions, 4 deletions
diff --git a/man/mdoc-update.1 b/man/mdoc-update.1 index a9666d93f4e..d0509192219 100644 --- a/man/mdoc-update.1 +++ b/man/mdoc-update.1 @@ -29,11 +29,9 @@ as added types and members, while preserving existing documentation. .Sp In some limited circumstances, renames will be tracked, minimizing the documentation burden when e.g. a parameter is renamed. -circumstances, -creates stubs and updates documentation in the \fBmdoc\fR(5) -documentation format from \fIASSEMBLIES\fR. .PP -\fBmdoc update\fR does not rely on documentation found within source code. +\fBmdoc update\fR does not rely on documentation found within source code, +though it can import XML Documentation Comments via the \fB\-i\fR option. .PP See \fBmdoc\fR(1) and \fBmdoc\fR(5) for more information. .SH OPTIONS @@ -177,11 +175,22 @@ Import documentation found within \fIFILE\fR. .Sp \fIFILE\fR may contain either \fIcsc /doc\fR XML or \fIECMA-335\fR XML. .TP +\fB\-L\fR, \fB\-\-lib\fR=\fIDIRECTORY\fR +Add \fIDIRECTORY\fR to the assembly search path, so that dependencies of +\fIASSEMBLIES\fR can be found without documenting those assemblies. +.TP \fB\-o\fR, \fB\-\-out\fR=\fIDIRECTORY\fR Place the generated stubs into \fIDIRECTORY\fR. .Sp When updating documentation, \fIDIRECTORY\fR is also the source directory. .TP +\fB\-r\fR=\fIASSEMBLY\fR +\fIASSEMBLY\fR is a dependency for one of \fIASSEMBLIES\fR which should +\fInot\fR be documented but is required to process one of \fIASSEMBLIES\fR. +Add the directory containing \fIASSEMBLY\fR to the assembly search path. +.Sp +This option is equivalent to specifying \fB\-L\fR `\fIdirname\fR ASSEMBLY`. +.TP \fB\-\-since\fR=\fIVERSION\fR When \fIupdating\fR documentation for an assembly, if a type or member is encountered which didn't exist in the previous version of the assembly a |