[sldev] Documenting the viewer source

[Dale Mahalko]

This reminds me, is there some way to click on something in the
source, and have Visual Studio tell me where that function or type
definition is coming from? Half the problem of learning the source is
just weaving through the deep web of libraries and typedefs that
support the actual code.

For example, any source file referencing "llcommon.h" drags along with
it a laundry list of 50 or more inter-related source files and it's
quite a chore to manually dig through them to find where a function or
struct is defined. I waded through this deep web of llcommon includes
way back when the client was first open-sourced..

https://wiki.secondlife.com/wiki/VFS_source_relationships#Common_source_elements


I'd like to be able to just click on anything in the source like "S32"
and have the compiler be able to respond with:

'The definition of "S32" originates in file
\linden\indra\common\stdtypes.h, line 38.'

And then have it offer to open that source reference in a new window
and highlight the referenced line(s).


This would permit the code to be more self-documenting. Can this be done?

- Scalar Tardis / Dale Mahalko



On Thu, Jul 17, 2008 at 6:00 PM, Rob Lanphier <robla at lindenlab.com> wrote:
> In the meeting, there was a request for more documentation.  We talked about
> several things on this front: