jdb/jlp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Finished basic grammar outline.

Browse Source
This commit is contained in:
Jonathan Bernard 2011-08-25 07:13:39 -05:00
parent 43c5c15ed7
commit 48eee1ca43
2 changed files with 28 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -3,4 +3,8 @@ Jonathan's Literate Programming
This project grew out of a desire for a documentation system that:
*
* generates all documentation from source-code comments,
* is capable of facilitating both JavaDoc-style API documentation as well as
literate programming style of documentation,
* has pluggable formatting (default to Markdown),

30
doc/grammar.rst
View File

@ -1,9 +1,25 @@
DocBlock -> Directive | MarkdownBlock
CodePage -> CodeBlock | DocBlock | CodePage
Directive ->
"@author" MarkdownBlock |
"@doc" MarkdownBlock |
"@example" MarkdownBlock |
"@org" LiteralString
// lookahead 2 needed here
DocBlock -> DirectiveBlock | MarkdownBlock | DocBlock
MarkdownBlock ->
DirectiveBlock ->
<DOC_START> <DIRECTIVE_START> "author" RemainingLine EOL MarkdownBlock? |
<DOC_START> <DIRECTIVE_START> "doc" RemainingLine EOL MarkdownBlock? |
<DOC_START> <DIRECTIVE_START> "example" RemainingLine EOL MarkdownBlock? |
<DOC_START> <DIRECTIVE_START> "org" OrgString EOL
MarkdownBlock -> MarkdownLine+
MarkdownLine ->
<DOC_START> NOT_DIRECTIVE_START RemainingLine <EOL>
RemainingLine -> NOT_EOL*
Tokens
------
DOC_START -> "%%"
EOL -> "\n"
NOT_EOL -> ~"\n"
DIRECTIVE_START -> "@"
NOT_DIRECTIVE_START -> ~"@"