Drop the semicolon from the title. Just use "Procedure: TBrowser.BuildRootTree".
You may want to consider leaving the return types out of the title as well. Just let the prototypes take care of it. If you had a link to just <TBrowser.ConnectToDB> (assuming the corresponding title matched so the link would work) hovering over that link will give you its prototype right from BuildRootTree's documentation.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
I thought that (begin) ...(end) will include code into documentation (like above). But this will not work.
So my question is what to change that regular source between (begin) and (end) will be included into html?
{
(begin)}
procedure TBrowser.BuildRootTree;
var
node : pVirtualNode;
Data,
subdata : PtrNodedata;
x : Integer;
begin
Tree.NodeDataSize := SizeOf(TNodedata);
...
{
(end)}
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Hi.
I tried to find out, how to get the first line of the comment following function/procedure.
It seems that this will not work for Pascal.
example:
{-----------------------------------------------------------------------------
Procedure: TBrowser.BuildRootTree;
bla Bla
See Also:
<TBrowser.ConnectToDB: boolean;>
-----------------------------------------------------------------------------}
procedure TBrowser.BuildRootTree;
Did anybody know how i can get last line as a prototype line in html page?
btw: if i change lanuage to C#, it will work but the rest of the document looks very strange :-(
Maybe i can cut&paste some perl code anywhere ;->
thanks in advance
Uwe
Drop the semicolon from the title. Just use "Procedure: TBrowser.BuildRootTree".
You may want to consider leaving the return types out of the title as well. Just let the prototypes take care of it. If you had a link to just <TBrowser.ConnectToDB> (assuming the corresponding title matched so the link would work) hovering over that link will give you its prototype right from BuildRootTree's documentation.
Yep! That's work.
I thought that (begin) ...(end) will include code into documentation (like above). But this will not work.
So my question is what to change that regular source between (begin) and (end) will be included into html?
{
(begin)}
procedure TBrowser.BuildRootTree;
var
node : pVirtualNode;
Data,
subdata : PtrNodedata;
x : Integer;
begin
Tree.NodeDataSize := SizeOf(TNodedata);
...
{
(end)}
It doesn't work that way. (start) and (end) are for text diagrams and example code within the comment itself. It won't include regular code.