tags:

views:

48

answers:

1
+1  Q: 

lua - metadata for documentation

I've read a comment from Norman Ramsey about using metadata for generating documentation in lua.

I'm attempting to generate documentation from my lib, and I'd rather not use luadoc if possible.

I'd like to know more about this "metadata-oriented" method for generating documentation - methodology, examples, or programs used.

Other answers are welcome, but this is a question that probably Norman can answer better than anyone else.

Thanks!

+1  A: 
Norman Ramsey  2010-06-23 14:48:00
The extra blank lines in the code examples arise from a bug in markdown, which Jeff has tagged 'by-design', so I think we have to assume this problem won't be fixed.
Norman Ramsey  2010-06-23 14:55:28
Ooh shiny! I like the idea! thanks! Please update your answer when you are ready to share the code, otherwise I'll not know that you published it! In the meantime, answer accepted!
egarcia  2010-06-23 15:31:44
@Norman, you could always try <pre> blocks in place of markdown indented code blocks. This is often better for Lua since SO's and markdown don't color it very well, and is usually better for quoting program output since it isn't code at all.
RBerteig  2010-06-24 00:20:43

related questions

How do I export the code documentation in C# / VisualStudio 2008?
Best Tips for documenting code using doxygen?
Generating Documentation from C# XML Comments
Where can I download the jQuery API documentation?
How do I document a module in Python?
Can you recommend good UML tutorials ?
What documentation and training are you pushing out with your app?
Tool to check Doxygen markup is up to date
Best GUI tool for documenting a SQL Server DB
Commenting code
Documenting Delphi
Javadoc template generator
What languages have the best/worst documentation and support communities?
Tool for generation MSDN-like documentation from <summary> tags?
Getting developers to use a wiki
Documenting program architecture
What tools are used to write documentation?
Who writes the documentation?
What is the prefered style for single decision and action statements?
SQL Database documentation?
Templates for lifecycle documentation
Best Multi-Language Documentation Generator
"documentation" conventions and auto checking them
Which tools do people use to create Data Dictionaries?
.Net XML comment into API Documentation