Skip to content

Commit

Permalink
release 0.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Doraku committed Dec 8, 2018
1 parent c275027 commit f3b79cf
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
As the name imply, this project lets you easily produce a "good enough" markdown documentation from the xml documentation produced by visual studio from comments.


[![NuGet](https://img.shields.io/badge/nuget-v0.1.0-brightgreen.svg)](https://www.nuget.org/packages/DefaultDocumentation)
[![NuGet](https://img.shields.io/badge/nuget-v0.2.0-brightgreen.svg)](https://www.nuget.org/packages/DefaultDocumentation)

- [Requirement](#Requirement)
- [Usage](#Usage)
Expand All @@ -27,7 +27,7 @@ List of supported balise taken from [here](https://docs.microsoft.com/en-us/dotn

- [ ] `<c>` not yet
- [ ] `<code>` not yet
- [x] `cref attribute` in `<see>` element
- [x] `cref attribute` in `<exception>`, `<see>` and `<seealso>` elements
- [ ] `<exemple>` not yet
- [x] `<exception>`
- [ ] `<include>` not yet
Expand All @@ -36,22 +36,22 @@ List of supported balise taken from [here](https://docs.microsoft.com/en-us/dotn
- [x] `<param>`
- [x] `<paramref>`
- [ ] `<permission>` not yet
- [ ] `<remarks>` not yet
- [x] `<remarks>`
- [x] `<returns>`
- [x] `<see>`
- [ ] `<seealso>` not yet
- [x] `<seealso>` handled the same as `<see>`
- [x] `<summary>`
- [x] `<typeparam>`
- [x] `<typeparamref>`
- [ ] `<value>` not yet

List of supported members taken from [here](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/processing-the-xml-file)
- [ ] `N Namespace` not yet
- [x] `T` except nested types, not tested
- [x] `T`
- [x] `F`
- [x] `P` except indexer
- [x] `M` missing special display for operator
- [ ] `E Event` not yet
- [x] `P`
- [x] `M` missing implicit/explicit operators
- [x] `E`
- [ ] `!` this is not supposed to happen

Obviously my goal was not to support everything from the start but only what I needed for my projects (_good enough_).
Expand Down
2 changes: 1 addition & 1 deletion source/DefaultDocumentation/DefaultDocumentation.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
<IsTool>true</IsTool>
<DevelopmentDependency>true</DevelopmentDependency>

<Version>0.1.0</Version>
<Version>0.2.0</Version>
<PackageReleaseNotes>
added E event support
added M operator support
Expand Down

0 comments on commit f3b79cf

Please sign in to comment.