John --
On Wed, Feb 27, 2013 at 8:56 AM, John Dexter <jdxsoluti...@gmail.com> wrote:
> Thanks for the reply...
>
Sure. I'm no expert, I just spent a chunk of last week doing a deep dive
into doxygen internals...
>
> On 27 February 2013 15:47, Anthony Foiani <anthony.foi...@gmail.com>wrote:
>
>>
>> I believe that INPUT is for the files / directories that you want
>> documented, while INCLUDE_PATH is for files that should be preprocessed but
>> not documented.
>>
>> So if you want logger.h to be documented, and it's in \src\include, then
>> you need to have that in your INPUT. (Or, as you say, run a separate
>> doxygen batch and use tags, but if you control the whole thing, and
>> everything under "src" makes a single cohesive entity, then I'd do them all
>> as one...)
>>
>
> I'm a bit confused what "preprocessed but not documented" means in this
> context. What would be the point of that exactly?
>
I suspect it's so that you can pick up macro definitions from sources
outside your own code base.
> It does sound that I've misunderstood and simple include dirs should be
> added to INPUT but I'd like to understand better the uses of INCLUDE_PATH
> if it is as you describe.
>
The places places it's used in the code are:
1. config (for obvious reasons)
2. doxygen (searches include path to build basename -> path dictionary)
3. preprocessor (for handling "#include").
Note that it is *not* used in the main read / generate loop, which looks at
INPUT only.
I think that INCLUDE_PATH serves the same function for doxygen as "-I"
serves for the typical C compiler -- it tells it where to look for include
files, and that's pretty much it.
The short version: files and/or directories for which you want to generate
documentation *must* be in INPUT (and modified by RECURSIVE, FILE_PATTERNS,
etc).
Again, this is just from a quick skim of the sources. Corrections
welcome. :)
Best regards,
Anthony Foiani
------------------------------------------------------------------------------
Everyone hates slow websites. So do we.
Make your web apps faster with AppDynamics
Download AppDynamics Lite for free today:
http://p.sf.net/sfu/appdyn_d2d_feb
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
