Age | Commit message (Collapse) | Author |
|
(#607)
* Remove file from submodule to resolve lgtm issue
* change to full path
* update
* Adopt lucence.net nuget package
|
|
* Support .NET language feature: function pointers
* update
* update
* add test cases
* add test dll
* update
* Use delegate * for other languages
* update
* Fix new member added for function pointers
* update
|
|
* HtmlGenerator: Load converters lazily
This is a workaround so that .NET 6 apps can use the .NET FW
build of monodoc.dll without worrying about TypeInitializationExceptions
for converters they don't use.
* Fix netstandard2.0 compatibility
* Replace SharpZipLib submodule with package reference
Remove mdoc/packages.config as well.
* Bump Lucene.Net.Light to latest version to support NetStandard
* monodoc: Change to SDK-style project
* monodoc: Move to netstandard2.0
* Replace all packages.config with PackageReference
Bump mdoc.Test.FSharp.fsproj to .NET 4.7.1 to fix issues using
System.ValueTuple.
* Adjust to mdoc.Test.FSharp.fsproj bump to v4.7.1
* mdoc.Test.FSharp.fsproj: Convert to SDK-style
Fixes errors building in VS2022.
* mdoc.Test.csproj: Update to SDK-style too
* mdoc.Test.csproj no longer needs a direct FSharp.Core reference
* mdoc.Test.FSharp.fsproj: Fix FSharp.Core reference
https://github.com/dotnet/fsharp/blob/main/docs/fsharp-core-notes.md#how-to-explicitly-reference-fsharpcore
* mdoc.Test.csproj: Restore manual WPF reference
* Use AppendTargetFrameworkToOutputPath to avoid touching Makefiles
* Update en.expected-fsharp/index.xml
|
|
* Fix bug 514755
* add test cases to cover bug 514755
* update
|
|
attached property. (#576)
* Fixed the issue of dual property const
* Added tests for attached entities and fix typos
* update
* update
* Switch to external WPF reference for build failure on macOS.
* Fixed attached events and dropped WPF
* Setting the test case of WPF conditionally on different platforms
* update
|
|
minor issue in the cpp formatter (#551)
Co-authored-by: @anmeng10101 <33647870+anmeng10101@users.noreply.github.com>
|
|
|
|
.NET Core platform assemblies from the installation path of the .NET Core by the custom DefaultAssemblyResolver for WSL, macOS, and Ubuntu OS environment.
|
|
and Ubuntu OS environment.
|
|
https://dev.azure.com/ceapex/Engineering/_workitems/edit/317995?src=WorkItemMention&src-action=artifact_link
|
|
methods. Enable support to suppress such methods from ecma xml creation.
|
|
For some C++ classes, generic parameters doesn't exist before `Resolve` is called. Added `type = type.Resolve();` for types with IsRequiredModifier == true.
Closes #200
|
|
Closes #132
|
|
|
|
|
|
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
|
|
You can `make prepare all check` to compile and run unit tests.
Additionally, you can open `apidoctools.sln` in Visual Studio to develop and debug.
_Please Note:_ You will have to `make prepare all CONFIGURATION=Debug` for VS to work, as this
compiles external dependencies, and copies them to the `bin/Debug` folder, where VS will be expecting them.
|