[nem-en] documentation comments again
Michal Moskal
michal.moskal at gmail.com
Fri Dec 22 13:36:06 CET 2006
Hi,
I've implemented first chunk of documentation comment parsing. It is
now on the trunk.
What it currently does is very limited. The rule is that any text must
be wrapped in some toplevel tag (summary, remarks, exception...) and
para/code/list tag. If it is not, <summary> or <remarks> (for first
and any other paragraph respectively) is added, and then the <para>.
Automatically created <para> is closed at empty line. This part seems
to work well.
The only other shortcut implemented at the moment is </> to be used as
any closing tag.
It should be easy to implement <[ ]> for <c>/<code> (I should do it soon).
Now for $something and $(a.b.c) I guess we don't want to have it
interpreted inside <code>? Or do we? If we don't I'll have to do it
inside the parser not the lexer (yeah, this XML thing has both). Also,
maybe we should be somewhat permissive about <, > and & inside <code>
?
Next there is that //< parameter description. Seems like a neat idea
for me, but I'm not sure if this is going to be easy to implement.
Then there is this $[foo : bar] thing that I don't really understand.
Am I right, that the proposed semantics is for it to mean <foo
cref=bar> ? Should it be closed at the next empty line?
Did I miss something?
I wish you all merry Christmas (either this weeked or in January :-) !
--
Michał
More information about the devel-en
mailing list