I know how to generate simple javadoc for a method, but I thought it would be very useful to automatically include links to the methods that my method calls. Is there any tool that will scan the method code and automatically place @see references to called methods for me in the javadoc? A quick example:
If I have a method A that calls B, C, and D, it would be great to append javadoc to A’s javadoc that indicates that it calls B, C and D (along with @see links to those methods so you can read the javadoc for them).
What I’m really looking for is a tool that will generate process flow documentation where all I do is document my code like I normally do, run this tool, and then I end up with documentation that will tell me what my method does, and all of the other methods that it calls (preferably in the order that the methods are called).
Surely such a tool exists (probably multiple ones of them), and I bet there are a lot of opinions on which one is the best.
Use “Doxygen”.
You can get the relationship of functions even without @see tag.
Remember to edit the conf file, make sure you have turn on “function_call” switch.(Sorry I am not quite sure about the switch name)