[NeXus-tech] doxygen of API

Paul Kienzle paul.kienzle at nist.gov
Thu Mar 5 01:05:20 GMT 2009


Any idea how hard it would be to integrate the python into the autodocs?

   - Paul

On Mar 4, 2009, at 2:17 PM, Peterson, Peter F. (pf9) wrote:

> Doxygen always give the source code and call graphs which is quite  
> a lot of information for someone who just wants to plot data from a  
> file. If it isn’t hard to trim out some of the fat I would do it. I  
> don’t believe that you need to have both available on the web though.
>
> P^2
>
>
> On 3/4/09 12:16 PM, "Akeroyd, FA (Freddie)"  
> <freddie.akeroyd at stfc.ac.uk> wrote:
>
>> I’ve now linked the doxygen documentation to the wiki and also  
>> added a link to the current doxygen warnings at
>>
>> http://download.nexusformat.org/
>>
>> Still some work to do such as:
>> -         Defining member groups for C++ functions
>>
>> -         Maybe expanding the “module” hierarchy
>>
>>
>> Also, is the current documentation a bit too verbose for the  
>> average user? It would be possible to do two passes of doxygen and  
>> generate two sets of pages, one not showing e.g. call graphs and  
>> internal functions
>>
>> Freddie
>>
>>
>> From: nexus-tech-bounces at nexusformat.org [mailto:nexus-tech- 
>> bounces at nexusformat.org] On Behalf Of Peterson, Peter F. (pf9)
>> Sent: 04 March 2009 14:59
>> To: NeXus Technical sub-committee list
>> Subject: Re: [NeXus-tech] doxygen of API
>>
>> Freddie,
>>
>> This is great. Do you have an idea when it will replace the  
>> existing API docs from the wiki?
>>
>> P^2
>>
>>
>> On 3/4/09 7:07 AM, "Akeroyd, FA (Freddie)"  
>> <freddie.akeroyd at stfc.ac.uk> wrote:
>> On the Modules tab at http://download.nexusformat.org/doxygen/ 
>> html/ I’ve created some initial function groups … doxygen supports  
>> hierarchies so we can subdivide further
>>
>> Freddie
>>
>>
>>
>> Scanned by iCritical.
>> _______________________________________________
>> NeXus-tech mailing list
>> NeXus-tech at nexusformat.org
>> http://lists.nexusformat.org/mailman/listinfo/nexus-tech
>>
>>
>>
>> Scanned by iCritical.
>>
>>
>> _______________________________________________
>> NeXus-tech mailing list
>> NeXus-tech at nexusformat.org
>> http://lists.nexusformat.org/mailman/listinfo/nexus-tech
> _______________________________________________
> NeXus-tech mailing list
> NeXus-tech at nexusformat.org
> http://lists.nexusformat.org/mailman/listinfo/nexus-tech

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.nexusformat.org/mailman/private/nexus-tech/attachments/20090304/8468f4dd/attachment.html 


More information about the NeXus-tech mailing list