Re: [xpcc-dev] Generating documentation for specific device

2016-04-07 Thread Niklas Hauser
Yes, it definitely is planned to do this automatically.

In fact I have a hacked together implementation for `scons doc`, which 
generates the HAL and builds the entire doxygen API specifically for your 
project.
It's on my backlog of things, I haven't worked on it for a while, and it only 
works for one device (it's very hacky).

I accidentally published that idea in the docs before I even started the 
implementation. I removed it again:
https://github.com/roboterclubaachen/xpcc.io/commit/298dec06096d5f6f03ff1400af44a55d85f77553

I'm always struggling with SCons, since it's APIs are not documented anywhere.

:-(
Niklas

> On 07.04.2016, at 12:00, Szabó Antal  wrote:
> 
> Ok, I found a hacy way, to modify the doxyfile to include the
> generated files for my device, but maybe this could be automated?
> 
> 2016-04-07 12:54 GMT+02:00 Szabó Antal :
>> HI,
>> 
>> I noticed that if I do `scons doc` the generated documentation doesn't
>> include any specific device, How can I generate the docs for a device?
>> 
>> 
>> Greetings,
>> Antal
> 
> ___
> xpcc-dev mailing list
> xpcc-dev@lists.rwth-aachen.de
> http://mailman.rwth-aachen.de/mailman/listinfo/xpcc-dev
___
xpcc-dev mailing list
xpcc-dev@lists.rwth-aachen.de
http://mailman.rwth-aachen.de/mailman/listinfo/xpcc-dev

Re: [xpcc-dev] Generating documentation for specific device

2016-04-07 Thread Szabó Antal
Ok, I found a hacy way, to modify the doxyfile to include the
generated files for my device, but maybe this could be automated?

2016-04-07 12:54 GMT+02:00 Szabó Antal :
> HI,
>
> I noticed that if I do `scons doc` the generated documentation doesn't
> include any specific device, How can I generate the docs for a device?
>
>
> Greetings,
> Antal

___
xpcc-dev mailing list
xpcc-dev@lists.rwth-aachen.de
http://mailman.rwth-aachen.de/mailman/listinfo/xpcc-dev


[xpcc-dev] Generating documentation for specific device

2016-04-07 Thread Szabó Antal
HI,

I noticed that if I do `scons doc` the generated documentation doesn't
include any specific device, How can I generate the docs for a device?


Greetings,
Antal
___
xpcc-dev mailing list
xpcc-dev@lists.rwth-aachen.de
http://mailman.rwth-aachen.de/mailman/listinfo/xpcc-dev