SXB documentation extractor
Peter Verkaik
Posts: 3,956
Hi,
Attached is·a small tool I wrote to extract documentation
from SXB sources.
When there is a tag '{$doc+} at column 1
all lines following that tag will be written to a .doc file
until a tag '{$doc-} at column 1 is encountered after
which lines are suppressed until another '{$doc+}
is encountered. Simple but effective as it allows
exactly what will be·written to the .doc file.
It is a commandline tool. You run it like
SXBdoc filename<enter>
If the filename contains spaces, enclose the filename in double quotes.
The extension .SXB is assumed and must not be given.
A file filename.doc will be generated.
Edit:
Also attached are two configuration files for the Crimson Editor (in SXBspec.zip).
Place those files in the Crimson folder spec.
When you load the .doc in the Crimson Editor, select
Document->Syntax Type->SXB
and you get colored comments and highlighted keywords.
You can then use a free pdf printer like pdf995 or primopdf
to print the documentation in full color.
regards peter
Post Edited (Peter Verkaik) : 3/22/2009 1:54:34 PM GMT
Attached is·a small tool I wrote to extract documentation
from SXB sources.
When there is a tag '{$doc+} at column 1
all lines following that tag will be written to a .doc file
until a tag '{$doc-} at column 1 is encountered after
which lines are suppressed until another '{$doc+}
is encountered. Simple but effective as it allows
exactly what will be·written to the .doc file.
It is a commandline tool. You run it like
SXBdoc filename<enter>
If the filename contains spaces, enclose the filename in double quotes.
The extension .SXB is assumed and must not be given.
A file filename.doc will be generated.
Edit:
Also attached are two configuration files for the Crimson Editor (in SXBspec.zip).
Place those files in the Crimson folder spec.
When you load the .doc in the Crimson Editor, select
Document->Syntax Type->SXB
and you get colored comments and highlighted keywords.
You can then use a free pdf printer like pdf995 or primopdf
to print the documentation in full color.
regards peter
Post Edited (Peter Verkaik) : 3/22/2009 1:54:34 PM GMT
Comments
What/where/how is Crimson?
▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
When the going gets weird, the weird turn pro. -- HST
1uffakind.com/robots/povBitMapBuilder.php
1uffakind.com/robots/resistorLadder.php
regards peter
for one of my libaries.
I am currently completing documentation for my
libraries and putting in the doc tags so only
public info and defined public constants appear in
the docs.
regards peter