mdoc update - mdoc(5) documentation format support


   mdoc update [OPTIONS]* ASSEMBLIES


   mdoc update is responsible for the following:

   *      Creating  documentation  stubs  based  on ASSEMBLIES.  The stub-
          creation process will create new mdoc(5) XML files for each type
          within  ASSEMBLIES,  and  provide  documentation  stubs for each
          member of those types.

   *      Update  documentation  stubs  based  on  ASSEMBLIES.    Existing
          mdoc(5)  documentation  can be updated to reflect changes within
          ASSEMBLIES, such as added types and  members,  while  preserving
          existing documentation.

          In   some   limited  circumstances,  renames  will  be  tracked,
          minimizing the documentation burden when  e.g.  a  parameter  is

   mdoc  update  does  not rely on documentation found within source code,
   though it can import XML Documentation Comments via the -i option.

   See mdoc(1) and mdoc(5) for more information.


          Allow mdoc update to delete members  from  documentation  files.
          The only members deleted are members which are no longer present
          within ASSEMBLIES and are not  present  in  any  other  assembly

          If  a  type  is no longer present, the documentation file is not
          deleted, but is instead renamed to have a .remove  extension.

          Version detection is done with the  //AssemblyVersion  elements;
          if there are no //AssemblyVersion elements for a given <Type> or
          <Member/>, then the <Type> will be renamed and/or the  <Member/>
          will be removed.

          EXPERIMENTAL.   This  is  not  100% reliable, but is intended to
          serve as an aid for documentation writers.

          Inspect member  bodies  to  determine  what  exceptions  can  be
          generated from the member.

          SOURCES  is  an  optional  comma-separated list of the following
          sources that should be searched for exceptions:

                  added   Only generate <exception/> elements for members
                            added during the current program execution.
                            This keeps mdoc-update from re-generating
                            <exception/> elements for all members (and thus
                            prevents re-insertion for members that had the
                            <exception/> elements removed).
                  all     Find exceptions created in the member itself,
                            references to members in the same assembly,
                            and references to members in dependent
                  asm     Find exceptions created in the member itself and
                            references to members within the same assembly
                            as the member.
                  depasm  Find exceptions created in the member itself and
                            references to members within dependent

          If SOURCES isn't provided (the default),  then  only  exceptions
          created within the member itself will be documented.

          LIMITATIONS:  Exception  searching  is  currently implemented by
          looking for the exception  types  that  are  explicitly  created
          based  on  the known compile-time types.  This has the following

          *      This will not find exceptions which are implicit  to  the
                 IL,      such      as      NullReferenceException     and

          *      This will find exceptions which are not thrown, e.g.

                     public void CreateAnException ()
                         Exception e = new Exception ();

          *      This will not "follow" delegate and interface calls:

                     public void UsesDelegates ()
                         Func<int, int> a = x => {throw new Exception ();};
                         a (4);

                 The function UsesDelegates() won't  have  any  exceptions

          *      This  will find exceptions which "cannot happen", such as
                 ArgumentNullExceptions for arguments which are "known" to
                 be non-null:

                     public void A ()
                         B ("this parameter isn't null");

                     public void B (string s)
                         if (s == null)
                             throw new ArgumentNullException ("s");

                 For  the  above, if --exceptions=asm is provided then A()
                 will be documented as throwing an  ArgumentNullException,
                 which cannot happen.

          Specify a flag to alter behavior.  Valid flags include:

                 See the -fno-assembly-versions documentation, below.

          Do    not    generate   /Type/AssemblyInfo/AssemblyVersion   and
          /Type/Members/Member/AssemblyInfo elements.

          This is useful to prevent "churn" during updates.  Normally,  if
          a  type  or  member  hasn't changed but the assembly version has
          changed, then all types and members will be updated to include a
          new  //AssemblyVersion  element,  thus  increasing the amount of
          changes that need review before committing (assuming all changes
          are actually reviewed before commit).

          WARNING:  This  will interact badly with the --delete option, as
          --delete uses the //AssemblyVersion elements  to  track  version
          changes.   Thus,  if  you  have  a member which is present in an
          early assembly version and is removed in a  subsequent  assembly
          version,   such   as   System.Text.UTF8Encoding.GetBytes(string)
          (which is present in .NET 1.0 but not in  .NET  2.0),  then  the
          member  will be removed when the --delete -fno-assembly-versions
          options are specified, the member  was  present  in  an  earlier
          version of the assembly, and the current version of the assembly
          does not contain the member.

          Consequently, this option should only be specified if types  and
          members will never be removed from an assembly.

   -i, --import=FILE
          Import documentation found within FILE.

          FILE may contain either csc /doc XML or ECMA-335 XML.

   -L, --lib=DIRECTORY
          Add  DIRECTORY to the assembly search path, so that dependencies
          of ASSEMBLIES can be found without documenting those assemblies.

   -o, --out=DIRECTORY
          Place the generated stubs into DIRECTORY.

          When  updating  documentation,  DIRECTORY  is  also  the  source

          ASSEMBLY  is a dependency for one of ASSEMBLIES which should not
          be documented but is required to process one of ASSEMBLIES.  Add
          the directory containing ASSEMBLY to the assembly search path.

          This option is equivalent to specifying -L `dirname ASSEMBLY`.

          When updating documentation for an assembly, if a type or member
          is encountered which didn't exist in the previous version of the
          assembly a <since version="VERSION"/> element will be inserted.

          Only update documentation for the type TYPE.

   -h, -?, --help
          Display a help message and exit.


   mdoc(1),    mdoc(5),   mdoc-assemble(1),   mdoc-export-html(1),   mdoc-


   Visit    for


   Visit for details



Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.

Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.

Free Software

Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.

Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.

Free Books

The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.

Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.


Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.

Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.