Date: Mon, 17 Mar 2014 20:54:43 +0100
> From: Fabio Mosti <fa...@videoarts.eu>
> hi everybody,
> in my application I use a simple array-based config system, something
> like this:
>
> $cf['section1']['param1'] = 'value';
> $cf['section1']['param2'] = 'value';
> $cf['section2']['param1'] = 'value';
>
> and so on... the problem is that in variable browsing section of the
> html docs the whole array is seen as a single $cf variable. There is a
> proper way to document the single cells of the array?
>
Looks like you are using PHP and named indices to simulate fields in a data
structure.
Disclaimer: I don't use PHP, so my examples below probably are not fully
correct. They are meant to illustrate my suggestions.
You might be able to just add @var directives to your source:
$cf['section1']['param1'] = 'value'; ## @var $cf_section1_param1
description
$cf['section1']['param2'] = 'value'; ## @var $cf_section1_param2
description
Not sure if this will actually work without trying it.
For Doxygen to actually see the individual elements of an array as
document-able entities, an input filter for Doxygen would be needed. The
filter output would something like:
$cf_section1_param1 = 'value'; ##< description
$cf_section1_param2 = 'value'; ##< description
------------------------------------------------------------------------------
Learn Graph Databases - Download FREE O'Reilly Book
"Graph Databases" is the definitive new guide to graph databases and their
applications. Written by three acclaimed leaders in the field,
this first edition is now available. Download your free book today!
http://p.sf.net/sfu/13534_NeoTech
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
