GenApi

A command line tool that lists out the APIs from a set of assemblies in multiple different formats (C# declarations, DocIds, TypeForwards, or type lists).

Usage

\\FxCore\Tools\bin\GenApi.exe /?

Usage: GenApi

  Parameters:
                                      Path for an specific assembly or a directory to get all assemblies.

  Qualifiers:
    [-?]                              Print this help guide.
    [-libPath:STRING]                 Delimited (',' or ';') set of paths to use for resolving assembly references
    [-apiList:STRING]                 (-al) Specify a api list in the DocId format of which APIs to include.
    [-writer:WRITERTYPE(CSDecl)]      (-w) Specify the writer type to use.  Legal values: CSDecl, DocIds, TypeForwards, TypeList.
    [-syntax:SYNTAXWRITERTYPE(Text)]  (-s) Specific the syntax writer type.  Only used if the writer is CSDecl Legal values: Text, Html, Xml.
    [-out:STRING]                     Output path.  Default is the console.
    [-apiOnly]                        (-api) [CSDecl] Include only API's not CS code that compiles.
    [-all]                            Include all API's not just public APIs.  Default is public only.
    [-memberHeadings]                 (-mh) [CSDecl] Include member headings for each type of member.
    [-hightlightBaseMembers]          (-hbm) [CSDecl] Highlight overridden base members.
    [-hightlightInterfaceMembers]     (-him) [CSDecl] Highlight interface implementation members.

Examples

Output a C# API list in Word format (-s:xml is for OpenXml which works in Word).

\\FxCore\Tools\bin\GenApi.exe [Assembly or Directory of Assemblies] -s:xml -apiOnly -out:APIList.xml

Output a C# API list in html:

\\FxCore\Tools\bin\GenApi.exe [Assembly or Directory of Assemblies] -s:html -apiOnly -out:APIList.html

Output a flat list of all APIs:

\\FxCore\Tools\bin\GenApi.exe [Assembly or Directory of Assemblies] -w:TypeList -out:APIList.txt