html links from @uses (or similar)

[jhood]

It would be very helpful when browsing documentation if we could specify related functions, classes, etc. to look at for more detail. IDLDoc already does a great job of linking in the class hierarchy, but it would also be useful if we could do this manually in some cases. This is especially useful where the _REF_EXTRA keyword is used for keyword inheritance. The best place to add this option might be where the @uses parameter is used.

[mgalloy]

Yes, I have thought about adding this several times. I was actually hoping to have IDLdoc determine this automatically, but I have to improve the parser quite a bit to do that (in other words, it's going to be a while for that).

In the meantime, an easier task would be to just make the author list the routines and classes in the @uses section. This should be fairly easy to reconcile with automatic output in the future.

Is there anything besides routines and classes that would be useful to link to?

[mgalloy]

Added links for directly mentioned routines and class in the Uses section in r592.

Might be useful to add routines and classes that are used by the routines/classes listed in the Uses section, the routines/classes used by those, etc. This would give the entire list of routines needed to run the given routine.

[jhood]

Replying to mgalloy:

Recursive resolution of the @uses might be helpful, but I think the first step that you've implemented is a great improvement in itself. I am anxious to try it.

What is the proper way to reference a class in this case (i.e. "class_name__define" or "class_name" . Thanks for the quick turn around time!!

[mgalloy]

I should use MG_CALLED_ROUTINES (in the introspection external) to find all the helper routines.