You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The initial part of the docs conversion process is running a csproj executable which converts all of the javadocs html files based on their 4.8.0 release tag into consumable markdown files that are compatible with our api docs (which use DocFx). NOTE: These are not the same as the API docs output that are created from the /// comments in our code. These are extra java doc files that document things like namespaces and libraries
Each time this conversion process executes it overwrites all markdown files which means that we don't want to be manually changing the output markdown files because if we did that we'd have to go analyze all changes made by this process and revert parts of the changed files that we have knowingly changed which is not fun or sustainable (there's a lot of files!)
So instead of manually changing the output files we have written code for various tweaks of these files to ensure they are output correctly. Some of these tweaks are specific to certain namespaces and projects, etc... For embedded code snippets we should be able to do the same thing:
Store .net code snippets in separate files, we'll need to come up with a scheme for this to associate a code snippet for where it needs to be merged in
During the conversion process we can detect java code snippets and then lookup our own external files to see if there's a snippet for that section available and if so, replace the java snippet with the .net one
~15(+) hrs
The text was updated successfully, but these errors were encountered:
The initial part of the docs conversion process is running a csproj executable which converts all of the javadocs html files based on their 4.8.0 release tag into consumable markdown files that are compatible with our api docs (which use DocFx). NOTE: These are not the same as the API docs output that are created from the
///
comments in our code. These are extra java doc files that document things like namespaces and librariesEach time this conversion process executes it overwrites all markdown files which means that we don't want to be manually changing the output markdown files because if we did that we'd have to go analyze all changes made by this process and revert parts of the changed files that we have knowingly changed which is not fun or sustainable (there's a lot of files!)
So instead of manually changing the output files we have written code for various tweaks of these files to ensure they are output correctly. Some of these tweaks are specific to certain namespaces and projects, etc... For embedded code snippets we should be able to do the same thing:
~15(+) hrs
The text was updated successfully, but these errors were encountered: