Skip to content

kasperhbo/java-docfx

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

259 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

JavaDoc Doclet for DocFX

This is a modified version of: github.com/googleapis/java-docfx-doclet.git so you can also use for your docs and generate yml + MD files for your JavaDoc.

TODO:

  1. Remove all google specific code from the doclet

  2. Make running the program easier

  3. Add more documentation

  4. Add more examples

  5. Add namespace

  6. Add usage instructions

  7. Add Templates

    Designed to generate YAML files from Javadoc output for DocFX consumption.

Features

Usage

License

Apache License 2.0

Googles Original README

at github.com/googleapis/java-docfx-doclet.git.

While the doclet helps output docfx yml, there are some differences in the way Google needs this outputed to align with the other languages and look appropriate on cloud.google.com.

The original github repository for the doclet can be found at github.com/docascode/docfx-doclet.

This doclet is forked from release 143274 from June 2020 as it is still compatible with DocFX V2. This doclet has since been refactored and various features and fixes have been included.

About

Custom doclet that generates YAML files from Javadoc output for DocFX consumption

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • Java 100.0%