Best solution for language documentation.

Posted by Simone Margaritelli on Stack Overflow See other posts from Stack Overflow or by Simone Margaritelli
Published on 2010-04-23T05:20:00Z Indexed on 2010/04/23 5:23 UTC
Read the original article Hit count: 306

Filed under:

documentation

|

grammar

I'm developing a new object oriented scripting language and the project itself is quite ready for audience now, so i'm starting to think about a serious (not as "drafty" as it is right now) way of document its grammar, functions from standard library and standard library classes. I've looked a bit around and almost every language hash its own web application for the documentation, Python uses Sphinx for instance.

Which is the best PHP (don't have the time/will to install mod_who_knows_what on my server) application to accomplish this? I've used mediawiki a bit but i found its tag system a little bit hard to use in this context.

Thanks for your answers.

© Stack Overflow or respective owner

Related posts about documentation

Hyperlinked, externalized source code documentation

as seen on Programmers - Search for 'Programmers'
Why do we still embed natural language descriptions of source code (i.e., the reason why a line of code was written) within the source code, rather than as a separate document? Given the expansive real-estate afforded to modern development environments (high-resolution monitors, dual-monitors, etc… >>> More
A tool to aid completion of missing or incomplete source code documentation

as seen on Stack Overflow - Search for 'Stack Overflow'
I have several finished, older PHP projects with a lot of includes that I would like to document in javadoc/phpDocumentor style. While working through each file manually and being forced to do a code review alongside the documenting would be the best thing, I am, simply out of time constraints,… >>> More
Quick C# Project Documentation in Visual Studio

as seen on Internet.com - Search for 'Internet.com'
Here's a quick way to document your .NET projects. >>> More
SQLAuthority News – Feature Pack for Microsoft SQL Server 2005 SP4

as seen on SQL Authority - Search for 'SQL Authority'
If you are still using SQL Server 2005 – I suggest that you consider migrating to later version of the SQL Server 2008/2008 R2. Due to any reason, you wanted to continue using SQL Server 2005, I suggest that you take a look at the Feature Pack for Microsoft SQL Server 2005 SP4. There are many… >>> More
SQLAuthority News – Best Practices for Data Warehousing with SQL Server 2008 R2

as seen on SQL Authority - Search for 'SQL Authority'
An integral part of any BI system is the data warehouse—a central repository of data that is regularly refreshed from the source systems. The new data is transferred at regular intervals by extract, transform, and load (ETL) processes. This whitepaper talks about what are best practices for Data… >>> More

Related posts about grammar

Convert The Context Free Grammar to LL1 Grammar

as seen on Stack Overflow - Search for 'Stack Overflow'
hi I want to write a program to gives grammar as input and change it to LL1. my problem is converting to LL1 I don't have any algorithm to convert. I earn grammar from some input text by a simple text analyzer but how I can change it to LL1 ? is there any algorithm that is clear to implement. >>> More
English Grammar Parsing in PHP (Link Grammar)

as seen on Stack Overflow - Search for 'Stack Overflow'
Is there anyway to use the Link Grammar or AbiSource grammar checker in PHP (or C# but I'd prefer php)? I need to have a tree structure for english sentences. Any ideas? The only things I found were in C and I can't use them on a shared host. >>> More
Good grammar for date data type for recursive descent parser LL(1)

as seen on Stack Overflow - Search for 'Stack Overflow'
I'm building a custom expression parser and evaluator for production enviroment to provide a limited DSL to the users. The parser itself as the DSL, need to be simple. The parser is going to be built in an exotic language that doesn't support dynamic expression parsing nor has any parser generator… >>> More
Parsing a string, Grammar file.

as seen on Stack Overflow - Search for 'Stack Overflow'
How would I separate the below string into its parts. What I need to separate is each < Word including the angle brackets from the rest of the string. So in the below case I would end up with several strings 1. "I have to break up with you because " 2. "< reason " (without the spaces) 3. "… >>> More
Efficient Context-Free Grammar parser, preferably Python-friendly

as seen on Stack Overflow - Search for 'Stack Overflow'
I am in need of parsing a small subset of English for one of my project, described as a context-free grammar with (1-level) feature structures (example) and I need to do it efficiently . Right now I'm using NLTK's parser which produces the right output but is very slow. For my grammar of ~450 fairly… >>> More