On Mon, Jun 29, 2015 at 10:58 AM, woody <knap...@realtime.net> wrote:
>
> It *has* to have the information though, whether or not it organizes it.
> When it scan a program, indentifies a symbol, it reports which line the
> symbol is defined on. It could and should
> also have an option to report ALL the lines.
>
Doxygen might only save the names of functions where each variable and
function are referenced, but not the line numbers.
The HTML source listings Doxygen can generate contain algorithmically
generated anchors to serve as target for links from the generated
documentation, so line numbers are not needed.
Certainly would be good if it could produce a cross-reference with line
numbers.
Well, consider the issue raised :D . It just seems obvious.
>
I'm just a user of Doxygen.
> Even after comments blocks are automatically inserted, I would think you
> will still have to do extensive editing to include descriptive prose.
>
>
> You might, but they would just be padding on existing lines more or less.
> So yes, but it is a lot easier and quicker to go into the code and add the
> comments or descriptive prose to an
> existing comment block. 1. You don't have to remember how to create the
> block. 2. with the blocks in place, documentation would certainly be
> easier.
>
My team and I have templates defined in the source code editors we use.
When reviewing/studying legacy code, we can insert the relevant temple and
fill in the descriptive prose. Or, more often, since what Doxygen needs is
so minimal, just type. for example:
/** One line description.
* More detail....
* @return Description of what's returned.
*/
or:
/**< One line description after a parameter or variable definition.
More detail.... */
One of the things coming down in the medical device world, is compliance
> with IEC 62304. One part of this requires detailed architectural
> descriptions and diagrams. Current code will ultimately
> have to be brought up to that standard, and all over the medical world,
> people are having to back document programs.
>
I don't know what requirements IEC 62304 imposes, particularly on "in line"
code documentation.
Doxygen is meant to make generating a separate document from special
comments contained in the code. The (limited) source analysis capability
Doxygen has is there to make adding and maintaining those comments easier
by allowing the coder/documentor to follow the principle of "Do Not Repeat
Yourself".
Feeding the output of Doxygen back in to the source files is possible. Most
probably something to be done using a post processor.
> I have attached a file, and hope it comes through.
>
> current_intensity is the variable. This shows that build_array uses it,
> as do a bunch of the routines that build array calls.
> There are many other places in the code where this variable are referenced.
>
Right now, Doxygen can produce a call graph similar to what your charts
shows in relation to "build_array" and what it calls.
Enhancing Doxygen to product a (textural) cross-reference should not be
hard. However, I can't speak to the internals of Doxygen.
The chart you produced with Source Insight is a hybrid of a call graph and
a graphical cross-reference. That is most likely best implemented as a post
processor.
> Doxygen has the info to do this, or would with an extension. I was hoping
> that graphvis would be able to take Doxygen's data
> and produce this kind of diagram automatically for each function,
> variable, and data structure.
>
With a cross-reference and the output Doxygen currently produces, post
processing should be able to produce most kinds of (code) relationship
diagrams.
Flow diagrams would require help from additional analysis tools.
Unfortunately, all such tools I know of that provide the kind of
sophisticated analysis that Source Insight does are expensive, proprietary
tools that work much like you describe Source Insight, unless you add
expensive, optional reporting extensions.
Graphvis is just a tool for interpreting description in DOT notation in to
graphical charts. It has no analysis capability. Doxygen uses it because it
was much easier to use it than to attempt to produce such diagrams directly.
------------------------------------------------------------------------------
Don't Limit Your Business. Reach for the Cloud.
GigeNET's Cloud Solutions provide you with the tools and support that
you need to offload your IT needs and focus on growing your business.
Configured For All Businesses. Start Your Cloud Today.
https://www.gigenetcloud.com/
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
