#62 HTML links + @see tag patch

[G.J. Doornink]

I have attached a patch which implements this feature.

It implements the Index, Previous, Next, Class
Hierarchy, Related Unit, Members, Classes, Types,
Constants, Variables and Functions.

It also implements the @see tag, which is implemented
as closely to the JavaDoc as possible.

I hope this is of any use.

[G.J. Doornink]

Implementation of HTML links + @see tag

[TridenT]

Logged In: YES
user_id=248829

I am currently testing your modifications.
I'm very happy about your submission, thanks for your help !
I will keep you informed about it, see u !
TridenT

[G.J. Doornink]

Logged In: YES
user_id=1852

I have a small fix to correctly create relative links in the
the see also links:

After applying above patch, in the body of the procedure
ExpandLinkTarget replace:
target := Tmp.BuildPathName;
with:
target := PathGetRelativePath(ExtractFilePath(
FHtmlOutputFolder + Tmp.BuildPathName + HTML_FILE_EXT),
FHtmlOutputFolder)+PathSeparator+Tmp.BuildPathName;

Regards,

[G.J. Doornink]

Logged In: YES
user_id=1852

I have updated the patch to:

• a cleaner implementation, split up into several functions
• improve @see tag target parsing
• replace spaces in generated anchors with underscores
• fix typo (Additionnal -> Additional)

Please note that this patch is IMHO not production quality,
since:

• some parts of the patch probably don't belong in
  DocGenHTML.pas
• @see tag target parsing should not discard specified
  method parameters, but use those in locating the target
• perhaps the whole @see tag parsing should be done in the
  source code parsing routines, which would, I think, also allow
  for nicer inline {@link } tag parsing

Anyway, not there yet but there's progress :)

Kind regards,

Gerrit Jan Doornink

[G.J. Doornink]

Implementation of HTML links + @see tag

[Aleksey Timohin]

How does this going?

It would be really lovely to have Related Units and @see tag.

Btw I even started to write my own implementation of @see tag. For now it generates "See also" section for any object that has @see tag, and searches for link in following order:
1) current class members
2) current unit items (classes, functions, variables, types)

My implementation allows:
1) Create links in Class Hierarchy section of Class documentation
2) Create links in methods/function parameters and return type
3) Create links with @see tags

But my version has some limitations:
1) it supports only simple tag (no full path to namespace.TClass#member)
2) I'm not really sure, that my implementation works in the same way as JavaDoc do
3) It uses Html Generator methods for searching for links
4) It does not supports inline link creation

I would like to help with that issue, but I'm not really familiar with project's code yet.

[TridenT]

To debose> How is it going ? Do you have a patch to submit ? Do you need help ?

[Aleksey Timohin]

I can't add files here, so added that patch in new submission with ID: 2955433

I haven't really tested it in production. Cause, I found, that this parser does not correctly process some of data types, and started to use doc-o-matic-express for documentation generation.

But it was pleasure to see your project structure with all those tests and classes separation.