API Docs Generator #12
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jamiebrynes7
force-pushed
the
feature/api-docs-generator
branch
from
916177c
to
a89cdf8
Compare
7 tasks
jamiebrynes7
force-pushed
the
feature/api-docs-generator
branch
from
258f0f5
to
5da8ba3
Compare
jessicafalk
reviewed
Jan 16, 2019
| { | ||
| private static List<string> BlackList = new List<string> | ||
| { | ||
| "index.xml" |
There was a problem hiding this comment.
maybe add a short comment on why this needs to be blacklisted
jessicafalk
reviewed
Jan 16, 2019
| public static string CompoundNameToRelativePath(string compoundName) | ||
| { | ||
| var targetNamespace = Options.Instance.TargetNamespace.Replace(".", "::") + "::"; | ||
| var markdownSplitPath = compoundName.Replace(targetNamespace, "").Split("::") |
jessicafalk
reviewed
Jan 16, 2019
| /// <returns>The type name.</returns> | ||
| public static string GetTypeFromFullyQualified(string fullyQualified) | ||
| { | ||
| return fullyQualified.Split(".").Reverse().First(); |
There was a problem hiding this comment.
why not just use Last()?
jessicafalk
reviewed
Jan 16, 2019
|
|
||
| private static void BuildTableOfContents(DoxygenDatabase database, string outputDirectory) | ||
| { | ||
| // Build the table of contents at {{outputDirectory}}/.toc/toc.md |
There was a problem hiding this comment.
that is the toc just for the API docs right? how would this work together with the rest of the documentation?
There was a problem hiding this comment.
Yes and you can use the include macro in the main ToC.
jessicafalk
reviewed
Jan 16, 2019
|
|
||
| private static void BuildDocs(DoxygenDatabase database, string outputDirectory) | ||
| { | ||
| foreach (var details in database.TypeDetails) |
There was a problem hiding this comment.
those loops could potentially be factored out into a method.
added 15 commits
March 11, 2019 10:51
jamiebrynes7
force-pushed
the
feature/api-docs-generator
branch
from
5ddc01c
to
5f096b1
Compare
added 2 commits
March 11, 2019 13:00
|
Moved to another repo |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Okay this is probably ready for a preliminary review.
I've tried to break it down into logical commits, but some parts reference future commits but it should be fine to just look at the API call name and infer what it does. Otherwise it needs a better name!