https://github.com/breakbb/doctotex
A compiler project to create a LaTex document out of Javadoc
https://github.com/breakbb/doctotex
Last synced: 8 months ago
JSON representation
A compiler project to create a LaTex document out of Javadoc
- Host: GitHub
- URL: https://github.com/breakbb/doctotex
- Owner: BreakBB
- Created: 2018-01-23T09:04:11.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-01-30T20:59:50.000Z (over 8 years ago)
- Last Synced: 2025-10-14T19:04:35.692Z (8 months ago)
- Language: Java
- Size: 46.9 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# docToTeX
A compiler project to create a TeX document out of Javadoc.
## Getting started
- Make sure to install ANTLR and set your CLASSPATH-variable correctly
- Generate the Java classes for all .g4 files to a folder of your choice (default is "gen")
- Compile those generated classes
### Show parsetree
- Use "grun Javadoc documentation" inside the folder of the generated classes to run the testrig. Add an "-gui" to see the parsetree.
- Enter some Javadoc code you want to test
### Compile to Tex
- Install the ANTLR plugin for IntelliJ
- Make sure ANTLR is included as library in the module settings of the project
- Run JavadocListener and make sure "src" and "gen" are marked as "Sources Root" in IntelliJ