Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/mono/api-doc-tools.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoel Martinez <joelmartinez@gmail.com>2017-03-03 21:51:13 +0300
committerJoel Martinez <joelmartinez@gmail.com>2017-03-03 22:32:17 +0300
commit6b00abca5aa0d4375ba28eb933d5ac7ebdc7e49c (patch)
treef528e79685d7837154ef27c665c746d1db9ca34b /external
parent0b6f479891f2730783cc680faa24793c5a1e6e89 (diff)
Frameworks Mode for Update Commandpreview-5.0.0.6
mdoc now supports documenting multiple frameworks. You can use this new functionality by passing the path to a configuration file in the `-frameworks` (or `-fx` for short) parameter. ``` mdoc update -o path/to/documentationXML -frameworks path/to/frameworks.xml ``` This command will result in one XML file per framework in the `path/to/documentationXML/FrameworksIndex` folder. ``` xml <?xml version="1.0" encoding="utf-8"?> <Framework Name="Two"> <Namespace Name="MyFramework.MyOtherNamespace"> <Type Name="MyFramework.MyOtherNamespace.MyOtherClass" Id="T:MyFramework.MyOtherNamespace.MyOtherClass"> <Member Id="M:MyFramework.MyOtherNamespace.MyOtherClass.#ctor" /> ... </Type> </Namespace> </Framework> ``` Configuration File This is a sample configuration file: ``` xml <?xml version="1.0" encoding="utf-8"?> <Frameworks> <Framework Name="One" Source="One"> <assemblySearchPath>dependencies/One</assemblySearchPath> </Framework> <Framework Name="Two" Source="Two"> <assemblySearchPath>dependencies/Two</assemblySearchPath> </Framework> </Frameworks> ``` Note that the `assemblySearchPath` is meant to house dependent assemblies that mono.cecil must be able to resolve. You can have as many as you need for each framework if you happen to have them separated into multiple folders. Also the `-L` parameter applies globally to every framework. Frameworks Config Bootstrap To simplify the tedium of creating the configuration file, a simple command was added that will use the folder structure to create a basic configuration file: ``` csharp mdoc fx-bootstrap path/to/frameworks ``` This will create a file at `path/to/frameworks/frameworks.xml`, using the folders in `path/to/frameworks` as the names/paths DocId Signatures You can now pass a flag to add a `DocId` signature to every `Type` and `Member` node. ``` mdoc update -o out/path some.dll -use-docid ``` _please note_: framework index files will _always_ use the DocId as their identifiers. Frameworks Index files Grouped by Namespace Framework index files now have types grouped by namespace. Example: ``` xml <?xml version="1.0" encoding="utf-8"?> <Framework Name="Two"> <Namespace Name="MyFramework.MyOtherNamespace"> <Type Name="MyFramework.MyOtherNamespace.MyOtherClass" Id="T:MyFramework.MyOtherNamespace.MyOtherClass"> <Member Id="M:MyFramework.MyOtherNamespace.MyOtherClass.#ctor" /> ... </Type> </Namespace> </Framework> ``` Bug Fixes and Enhancements - Resolves #13 - Resolves #27 - Resolves #31 - Resolves #33
Diffstat (limited to 'external')
m---------external/Mono.Cecil0
1 files changed, 0 insertions, 0 deletions
diff --git a/external/Mono.Cecil b/external/Mono.Cecil
-Subproject 272feac16778a07efc32096eea07fe6db82575f
+Subproject e677df735240934660a166869c44826b26d85e9