Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Analize properties of documentation making methods, decide for the best #21

Closed
fodor0205 opened this issue Aug 25, 2011 · 4 comments
Closed

Analize properties of documentation making methods, decide for the best #21

fodor0205 opened this issue Aug 25, 2011 · 4 comments
Assignees
@Wizek
Labels
back end front end high priority
Milestone
0.0.7

Comments

@fodor0205
Copy link
Contributor

No description provided.

@ghost ghost assigned Wizek Aug 25, 2011
@fodor0205
Copy link
Contributor Author

Maybe:
https://github.com/jashkenas/docco

@Wizek
Copy link
Owner

Wizek commented Aug 25, 2011

Possibilities:

  • Automated generators from text
    • Docco
      • adventages
        • Freeform, no restrictions what so ever
        • Markdown parsed in comments
        • Syntax highlighting for code
      • disadventages
        • No predefined framework, one has to invent their onw
      • known issues
    • Dox
      • adventages
      • disadventages
      • known issues
        • Crashes if there is even a single folder around the main script dir
    • Doc.md
      • adventages
      • disadventages
      • known issues
        • Restrictive, only counts global variables and exported functions
  • Other
    • e.g. writing in github wiki
    • What else?

@Wizek
Copy link
Owner

Wizek commented Aug 26, 2011

Docco makes nice-looking doc: (link)
Docco-generated

Wizek added a commit that referenced this issue Aug 26, 2011
@Wizek
Docco as primary docs generation for a while (#21)
f777ff7 
The others are put to rest in buildDocs
@Wizek
Copy link
Owner

Wizek commented Aug 28, 2011

For some time, this is settled for Docco-

@Wizek Wizek closed this as completed Aug 28, 2011
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Wizek Wizek

Labels
back end front end high priority
Projects
None yet
Milestone
0.0.7
Development

No branches or pull requests
2 participants
@Wizek @fodor0205