Skip to content

Utils for generation markdown docs from code comments documentation

Notifications You must be signed in to change notification settings

SavinMike/mkdocer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mkdocer

Utils which create markdown docs from code comments documentation such as javaDoc or appledoc. Now available next languages:

  • ActionScript
  • Java
  • Kotlin
  • ObjectiveC

Implementation

For generation documentation you should run next command line:

java -jar docer.jar /PATH/TO/PROJECT/ /OUTPUT/PATH/ OS

Where OS (optional param) is one of:

  • Andorid
  • Ios

If OS is specified then docer will scan proguard files for android or xcodeProj for iOS and add to docs only public classes/headers

About

Utils for generation markdown docs from code comments documentation

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages