Problems with JavaDoc TAG @return

[Nobody/Anonymous]

Hi I tried to use DelphiCodeToDoc - and used the project itself and produced documentation for it.

For the followin function (in Extract\VisitStructure.pas) the documentation for the return section read:
#No TAG found in source code#
when it should have read : string with source code

How come?

{*------------------------------------------------------------------------------
Get source code of the node and its childs, separated with space
@param tkNode Node currently processed (TParseTreeNode)
@return string with source code
-------------------------------------------------------------------------------}
function TVInterfaceStructure.GetSourceCode(const tkNode: TObject): string;
var
ptNode: TParseTreeNode;

function RecurseGetSource(const stNode: TParseTreeNode): string;
var
liLoop: integer;
begin
Result := '';
if stNode.IsLeaf then
if TSourceToken(stNode).IsSolid then
Result := TSourceToken(stNode).SourceCode + ' ';

if stNode.HasChildren then
 for liLoop := 0 to stNode.ChildNodeCount - 1 do
  Result := Result + RecurseGetSource(stNode.ChildNodes[liLoop]);

end;

begin
ptNode := TParseTreeNode(tkNode);
Result := RecurseGetSource(ptNode);
end;

[TridenT]

yes, the @return TAG works no more in v0.10beta.
It is fixed in v0.10beta1 (available via CVS).

see tracker : http://sourceforge.net/tracker/index.php?func=detail&aid=1069251&group_id=96281&atid=614255

I will release the next revision (with this bug fixed) at the end of the week.

You can subscribe to the News mailing list to be aware of this king of bug (but I minimize the risk since I use DUnit test case).

TridenT