https://github.com/kgn/mdoc

GitHub markdown documentation generator for Objective-C
https://github.com/kgn/mdoc

Last synced: about 1 month ago
JSON representation

GitHub markdown documentation generator for Objective-C

• Host: GitHub
• URL: https://github.com/kgn/mdoc
• Owner: kgn
• Created: 2012-03-16T07:22:41.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2012-08-13T04:02:39.000Z (over 12 years ago)
• Last Synced: 2023-03-11T10:28:06.995Z (over 1 year ago)
• Language: Python
• Homepage:
• Size: 105 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# mdoc [M↓]

GitHub markdown documentation generator for Objective-C

Comments in header files with three slashes(`///`) or block comments that start with two asterisks(`/**`) are collected up then dumped out for each method. These comments may also contain markdown.

The command line takes two arguments, the first is the directory to recursivly search for header files. The second is the readme file to write the markdown to. The second argument is optional, if it's left off the markdown will be written to stdout.

    python mdoc.py [project root] [output readme]

Two examples of mdoc being used in the wild are on [BBlock](https://github.com/kgn/BBlock) and [KGLib](https://github.com/kgn/KGLib).