[kplato] Writing APIDox proposal

[Dag Andersen]

On Thursday 30 March 2006 20:55, Pierre-Andre Galmes wrote:
> Hello,
>
> last questions before starting :
>
> - Which Koffice version should I work on ? I downloaded the
> snapshot 521895 but not the svn one. Do I need the svn version ? Do
> I need a newer version ?
Snapshot should be fine. I don't know if you need svn to build the 
docs, though.
>
> - How should I enable the generation of APIDOX from the Koffice
> project ? Should I follow the APIDOX tutorial :
I haven't taken the time to learn the syntax :( so I'm not much help.

You'll also find a lot of wrong formatting along with incomplete 
comments etc.
>
> http://developer.kde.org/documentation/library/howto.php#build
>
> This seems to be already enabled in Koffice. Should I regenerate
> the Makefiles then ?
>
> At the moment, I get the following message :
>
> pagalmes at linux:~/Desktop/koffice-521895> make apidox
> make[1]: Entering directory `/home/pagalmes/Desktop/koffice-521895'
> make[1]: Nothing to do for « apidox-am-toplevel-no ».
> make[1]: Leaving directory `/home/pagalmes/Desktop/koffice-521895'
>
> Any idea how to make it work ?
>
> - How can I generate only doc for the Kplato module and not for the
> others applications ?
>
> - Is there an IRC channel where you go to ?
Not I, possibly Raphael?
>
> - In which way should I provide the comments ? Do you want a diff
> file ? the original file ? Any other format ?
diffs are fine, diff -u3 to get some context.
>
> As I will go to a place with not internet next week, I would like
> to have an entire system setup for writing and testing this
> documentation system before sunday. That way I will start working
> on apidox during the evenings.
Fine :) and thanks.
>
> Thanks

-- 
Mvh,
Dag Andersen