You are viewing a plain text version of this content. The canonical link for it is here.
Posted to c-dev@axis.apache.org by Samisa Abeysinghe <sa...@yahoo.com> on 2004/06/15 04:46:29 UTC

API doc generation with Doxygen

Hi,
    I updated the Stub.h and made sure the API doc comments work with doxygen.

    However the latest changes done on the file by someone else has made the doxygen tool not to
pick the comments and does not generate properly. 
    This is the second time around that the work done by me was made non functional. (the earlier
situation was in case of the WSDL2WS tool) 
    I think we better have some diciplined testing before commits are made. 
  
    In case of doxygen please make sure to verify that documents are generated properly. 

    Additionally, I cannot locate docs related to Transport abstraction and parser abstraction
within the API docs generated. 

    I am kind of frustrated on the amount of rework/rechecks that I have to do. Please fix the
Stub/parser abstraction and trasport abstraction documentation, so that users could program using
those.

Thanks,
Samisa...


	
		
__________________________________
Do you Yahoo!?
Friends.  Fun.  Try the all-new Yahoo! Messenger.
http://messenger.yahoo.com/ 

RE: suporting contributions (or not ...)

Posted by Susantha Kumara <su...@opensource.lk>.
> -----Original Message-----
> From: Aleksander Slominski [mailto:aslom@cs.indiana.edu]
> Sent: Tuesday, June 15, 2004 9:38 AM
> To: Apache AXIS C Developers List
> Subject: suporting contributions (or not ...)
> 
> Samisa Abeysinghe wrote:
> 
> >    I am kind of frustrated on the amount of rework/rechecks that I
have
> to do. Please fix the
> >Stub/parser abstraction and trasport abstraction documentation, so
that
> users could program using
> >those.
> >
> >
> 
> Samisa,
> 
> i can only second this. to this day i still do not know why WSDL2WS
has so
> much code copied from (some version of) AXIS-Java that so easily gets
out
> of sync and there is no unit tests to verify what modifications were
added

Yes I too asked the original developer Srinath who wrote the code to
extract the WSDL information from the SymbolTable class about this.

Srinath: could you please help us to understand why this. I mean
overriding ElementDecl class etc


> ...
> 
> thanks,
> 
> alek
> 
> --
> The best way to predict the future is to invent it - Alan Kay



suporting contributions (or not ...)

Posted by Aleksander Slominski <as...@cs.indiana.edu>.
Samisa Abeysinghe wrote:

>    I am kind of frustrated on the amount of rework/rechecks that I have to do. Please fix the
>Stub/parser abstraction and trasport abstraction documentation, so that users could program using
>those.
>  
>

Samisa,

i can only second this. to this day i still do not know why WSDL2WS has so much code copied from (some version of) AXIS-Java that so easily gets out of sync and there is no unit tests to verify what modifications were added ...

thanks,

alek

-- 
The best way to predict the future is to invent it - Alan Kay


RE: API doc generation with Doxygen

Posted by Samisa Abeysinghe <sa...@yahoo.com>.
> attractive. Does somebody know how to make the index page more informative
> and have some introduction like thing.

http://www.stack.nl/~dimitri/doxygen/faq.html

How to get information on the index page in HTML?

You should use the \mainpage command inside a comment block like this:

/*! \mainpage My Personal Index Page 
* * \section intro_sec Introduction 
* * This is the introduction. 
* * \section install_sec Installation 
* * \subsection step1 Step 1: Opening the box 
* * etc... */ 

Samisa...


	
		
__________________________________
Do you Yahoo!?
Friends.  Fun.  Try the all-new Yahoo! Messenger.
http://messenger.yahoo.com/ 

RE: API doc generation with Doxygen

Posted by da...@opensource.lk.
+1 for that suggestion,
because generating the api from doxygenconf is very simple process.
I think that the generated doxygen api's pages index file is not very
attractive. Does somebody know how to make the index page more informative
and have some introduction like thing.

damitha
> Hi Samisa,
>
> I think this has happened with my commit with documentation of Parser
> and Transport related header files. Actually I did not try to generate
> the API documentation with doxygen before commiting. I only compiled and
> ran Axis to verify that it works and commited. I apologize for any
> inconvenience caused.
>
> Shall we make the tradition from now on that any developer should also
> run doxygen any verify correct API doc generation before commiting.
>
>
>> -----Original Message-----
>> From: Samisa Abeysinghe [mailto:samisa_abeysinghe@yahoo.com]
>> Sent: Tuesday, June 15, 2004 8:46 AM
>> To: Apache AXIS C Developers List
>> Subject: API doc generation with Doxygen
>>
>> Hi,
>>     I updated the Stub.h and made sure the API doc comments work with
>> doxygen.
>>
>>     However the latest changes done on the file by someone else has
> made
>> the doxygen tool not to
>> pick the comments and does not generate properly.
>
> That was my mistake. I am sorry for that.
>
>>     This is the second time around that the work done by me was made
> non
>> functional. (the earlier
>> situation was in case of the WSDL2WS tool)
>>     I think we better have some diciplined testing before commits are
>> made.
>
> Yes this is not the first time that this has happened. I today found
> that WSDL2Ws tool does not generate the default constructor of client
> side stub with the endpoint taken from the WSDL. Some one has removed
> that part of code in WSDL2Ws tool.
>
> We have to avoid happening these in the future.
>
>>
>>     In case of doxygen please make sure to verify that documents are
>> generated properly.
>>
>>     Additionally, I cannot locate docs related to Transport
> abstraction
>> and parser abstraction
>> within the API docs generated.
>>
>>     I am kind of frustrated on the amount of rework/rechecks that I
> have
>> to do. Please fix the
>> Stub/parser abstraction and trasport abstraction documentation, so
> that
>> users could program using
>> those.
>>
>> Thanks,
>> Samisa...
>>
>
> Thanks,
> --
> Susantha Kumara
> Lanka Software Foundation
> Office : +94112591785
> Mobile : +94777420453
>
>
>


pre-commit checks [Re: API doc generation with Doxygen

Posted by Aleksander Slominski <as...@cs.indiana.edu>.
hi,

instead of relying on tradition i would suggest to add pre-commit target 
(to makefile or build.xml <-- java is required anyway to compile 
wsdl2ws) and have it recompile all code, run unit tests and call doxygen.

only if all of above succeeds one should do check in.

what happened to nightly builds? they could do the same pre-commit 
checks on nightly basis.

thanks,

alek

Samisa Abeysinghe wrote:

>Hi Susantha,
>    Is it possible for you to fix the problems.
>    I cannot still generate the docs.
>Thanks,
>Samisa
>
>
>--- Susantha Kumara <su...@opensource.lk> wrote:
>  
>
>>Hi Samisa,
>>
>>I think this has happened with my commit with documentation of Parser
>>and Transport related header files. Actually I did not try to generate
>>the API documentation with doxygen before commiting. I only compiled and
>>ran Axis to verify that it works and commited. I apologize for any
>>inconvenience caused.
>>
>>Shall we make the tradition from now on that any developer should also
>>run doxygen any verify correct API doc generation before commiting. 
>>
>>
>>    
>>
>>>-----Original Message-----
>>>From: Samisa Abeysinghe [mailto:samisa_abeysinghe@yahoo.com]
>>>Sent: Tuesday, June 15, 2004 8:46 AM
>>>To: Apache AXIS C Developers List
>>>Subject: API doc generation with Doxygen
>>>
>>>Hi,
>>>    I updated the Stub.h and made sure the API doc comments work with
>>>doxygen.
>>>
>>>    However the latest changes done on the file by someone else has
>>>      
>>>
>>made
>>    
>>
>>>the doxygen tool not to
>>>pick the comments and does not generate properly.
>>>      
>>>
>>That was my mistake. I am sorry for that.
>> 
>>    
>>
>>>    This is the second time around that the work done by me was made
>>>      
>>>
>>non
>>    
>>
>>>functional. (the earlier
>>>situation was in case of the WSDL2WS tool)
>>>    I think we better have some diciplined testing before commits are
>>>made.
>>>      
>>>
>>Yes this is not the first time that this has happened. I today found
>>that WSDL2Ws tool does not generate the default constructor of client
>>side stub with the endpoint taken from the WSDL. Some one has removed
>>that part of code in WSDL2Ws tool.
>> 
>>We have to avoid happening these in the future.
>>
>>    
>>
>>>    In case of doxygen please make sure to verify that documents are
>>>generated properly.
>>>
>>>    Additionally, I cannot locate docs related to Transport
>>>      
>>>
>>abstraction
>>    
>>
>>>and parser abstraction
>>>within the API docs generated.
>>>
>>>    I am kind of frustrated on the amount of rework/rechecks that I
>>>      
>>>
>>have
>>    
>>
>>>to do. Please fix the
>>>Stub/parser abstraction and trasport abstraction documentation, so
>>>      
>>>
>>that
>>    
>>
>>>users could program using
>>>those.
>>>
>>>Thanks,
>>>Samisa...
>>>
>>>      
>>>
>>Thanks,
>>--
>>Susantha Kumara
>>Lanka Software Foundation
>>Office : +94112591785
>>Mobile : +94777420453
>>
>>
>>    
>>
>
>
>
>	
>		
>__________________________________
>Do you Yahoo!?
>Friends.  Fun.  Try the all-new Yahoo! Messenger.
>http://messenger.yahoo.com/ 
>  
>


-- 
The best way to predict the future is to invent it - Alan Kay


RE: API doc generation with Doxygen

Posted by Susantha Kumara <su...@opensource.lk>.
Hi Samisa,

I read some doxygen docs at,

file:/usr/share/doc/doxygen-doc/html/index.html

and found the problem.

The problem was we had following line in doxygenconf 

ENABLE_PREPROCESSING   = YES

This line says doxygen to consider the C preprocessor directives and as
we have not defined __cplusplus in doxygenconf any code wrapped with
#ifdef __cplusplus ... #endif are ignored.

Its usefull that we turn off preprocessing because we need documentation
to be generated for everything (irrespective of compiler directives).

so I made 

ENABLE_PREPROCESSING   = NO

Thanks,

Susantha
---

On Wed, 2004-06-16 at 09:54, Samisa Abeysinghe wrote:
> May be the problem is that there are 2 classes/structs in the header file.
> I think doxygen is capable of hadling this situation.
> If not we can move the classes to seperate headers.
> 
> Thanks,
> Samisa...
> 
> --- Susantha Kumara <su...@opensource.lk> wrote:
> > Hi Samisa,
> > 
> > I checked the doxygen comments. But I could not yet locate the problem.
> > I will try to locate the problem ASAP.
> > 
> > ---
> > Susantha
> > 
> > > -----Original Message-----
> > > From: Samisa Abeysinghe [mailto:samisa_abeysinghe@yahoo.com]
> > > Sent: Tuesday, June 15, 2004 1:00 PM
> > > To: Apache AXIS C Developers List
> > > Subject: RE: API doc generation with Doxygen
> > > 
> > > Hi Susantha,
> > >     Is it possible for you to fix the problems.
> > >     I cannot still generate the docs.
> > > Thanks,
> > > Samisa
> > > 
> > > 
> > > --- Susantha Kumara <su...@opensource.lk> wrote:
> > > > Hi Samisa,
> > > >
> > > > I think this has happened with my commit with documentation of
> > Parser
> > > > and Transport related header files. Actually I did not try to
> > generate
> > > > the API documentation with doxygen before commiting. I only compiled
> > and
> > > > ran Axis to verify that it works and commited. I apologize for any
> > > > inconvenience caused.
> > > >
> > > > Shall we make the tradition from now on that any developer should
> > also
> > > > run doxygen any verify correct API doc generation before commiting.
> > > >
> > > >
> > > > > -----Original Message-----
> > > > > From: Samisa Abeysinghe [mailto:samisa_abeysinghe@yahoo.com]
> > > > > Sent: Tuesday, June 15, 2004 8:46 AM
> > > > > To: Apache AXIS C Developers List
> > > > > Subject: API doc generation with Doxygen
> > > > >
> > > > > Hi,
> > > > >     I updated the Stub.h and made sure the API doc comments work
> > with
> > > > > doxygen.
> > > > >
> > > > >     However the latest changes done on the file by someone else
> > has
> > > > made
> > > > > the doxygen tool not to
> > > > > pick the comments and does not generate properly.
> > > >
> > > > That was my mistake. I am sorry for that.
> > > >
> > > > >     This is the second time around that the work done by me was
> > made
> > > > non
> > > > > functional. (the earlier
> > > > > situation was in case of the WSDL2WS tool)
> > > > >     I think we better have some diciplined testing before commits
> > are
> > > > > made.
> > > >
> > > > Yes this is not the first time that this has happened. I today found
> > > > that WSDL2Ws tool does not generate the default constructor of
> > client
> > > > side stub with the endpoint taken from the WSDL. Some one has
> > removed
> > > > that part of code in WSDL2Ws tool.
> > > >
> > > > We have to avoid happening these in the future.
> > > >
> > > > >
> > > > >     In case of doxygen please make sure to verify that documents
> > are
> > > > > generated properly.
> > > > >
> > > > >     Additionally, I cannot locate docs related to Transport
> > > > abstraction
> > > > > and parser abstraction
> > > > > within the API docs generated.
> > > > >
> > > > >     I am kind of frustrated on the amount of rework/rechecks that
> > I
> > > > have
> > > > > to do. Please fix the
> > > > > Stub/parser abstraction and trasport abstraction documentation, so
> > > > that
> > > > > users could program using
> > > > > those.
> > > > >
> > > > > Thanks,
> > > > > Samisa...
> > > > >
> > > >
> > > > Thanks,
> > > > --
> > > > Susantha Kumara
> > > > Lanka Software Foundation
> > > > Office : +94112591785
> > > > Mobile : +94777420453
> > > >
> > > >
> > > 
> > > 
> > > 
> > > 
> > > 
> > > __________________________________
> > > Do you Yahoo!?
> > > Friends.  Fun.  Try the all-new Yahoo! Messenger.
> > > http://messenger.yahoo.com/
> > 
> > 
> 
> 
> 
> 		
> __________________________________
> Do you Yahoo!?
> Yahoo! Mail Address AutoComplete - You start. We finish.
> http://promotions.yahoo.com/new_mail
> 


API docs

Posted by Samisa Abeysinghe <sa...@yahoo.com>.
Hi all,
    I generated the API docs with cvs using doxygen and it works!!

    Now I have few throughts
1. There are some classes that are not documented in the generated API doc. Are they not required
by the user?

2. As I know, there is an option in doxygen to group classes into groups.
We have the following sections in Axis C++. Can we group the classes in API docs generated?
Trasport abstraction
Parser abstraction
Stub
Exceptions
Handlers

3. We could add comments to appear in the index page of the generated  API. I think it would be
nice to have some index page.

Thanks,
Samisa...



	
		
__________________________________
Do you Yahoo!?
New and Improved Yahoo! Mail - 100MB free storage!
http://promotions.yahoo.com/new_mail 

RE: API doc generation with Doxygen

Posted by Samisa Abeysinghe <sa...@yahoo.com>.
May be the problem is that there are 2 classes/structs in the header file.
I think doxygen is capable of hadling this situation.
If not we can move the classes to seperate headers.

Thanks,
Samisa...

--- Susantha Kumara <su...@opensource.lk> wrote:
> Hi Samisa,
> 
> I checked the doxygen comments. But I could not yet locate the problem.
> I will try to locate the problem ASAP.
> 
> ---
> Susantha
> 
> > -----Original Message-----
> > From: Samisa Abeysinghe [mailto:samisa_abeysinghe@yahoo.com]
> > Sent: Tuesday, June 15, 2004 1:00 PM
> > To: Apache AXIS C Developers List
> > Subject: RE: API doc generation with Doxygen
> > 
> > Hi Susantha,
> >     Is it possible for you to fix the problems.
> >     I cannot still generate the docs.
> > Thanks,
> > Samisa
> > 
> > 
> > --- Susantha Kumara <su...@opensource.lk> wrote:
> > > Hi Samisa,
> > >
> > > I think this has happened with my commit with documentation of
> Parser
> > > and Transport related header files. Actually I did not try to
> generate
> > > the API documentation with doxygen before commiting. I only compiled
> and
> > > ran Axis to verify that it works and commited. I apologize for any
> > > inconvenience caused.
> > >
> > > Shall we make the tradition from now on that any developer should
> also
> > > run doxygen any verify correct API doc generation before commiting.
> > >
> > >
> > > > -----Original Message-----
> > > > From: Samisa Abeysinghe [mailto:samisa_abeysinghe@yahoo.com]
> > > > Sent: Tuesday, June 15, 2004 8:46 AM
> > > > To: Apache AXIS C Developers List
> > > > Subject: API doc generation with Doxygen
> > > >
> > > > Hi,
> > > >     I updated the Stub.h and made sure the API doc comments work
> with
> > > > doxygen.
> > > >
> > > >     However the latest changes done on the file by someone else
> has
> > > made
> > > > the doxygen tool not to
> > > > pick the comments and does not generate properly.
> > >
> > > That was my mistake. I am sorry for that.
> > >
> > > >     This is the second time around that the work done by me was
> made
> > > non
> > > > functional. (the earlier
> > > > situation was in case of the WSDL2WS tool)
> > > >     I think we better have some diciplined testing before commits
> are
> > > > made.
> > >
> > > Yes this is not the first time that this has happened. I today found
> > > that WSDL2Ws tool does not generate the default constructor of
> client
> > > side stub with the endpoint taken from the WSDL. Some one has
> removed
> > > that part of code in WSDL2Ws tool.
> > >
> > > We have to avoid happening these in the future.
> > >
> > > >
> > > >     In case of doxygen please make sure to verify that documents
> are
> > > > generated properly.
> > > >
> > > >     Additionally, I cannot locate docs related to Transport
> > > abstraction
> > > > and parser abstraction
> > > > within the API docs generated.
> > > >
> > > >     I am kind of frustrated on the amount of rework/rechecks that
> I
> > > have
> > > > to do. Please fix the
> > > > Stub/parser abstraction and trasport abstraction documentation, so
> > > that
> > > > users could program using
> > > > those.
> > > >
> > > > Thanks,
> > > > Samisa...
> > > >
> > >
> > > Thanks,
> > > --
> > > Susantha Kumara
> > > Lanka Software Foundation
> > > Office : +94112591785
> > > Mobile : +94777420453
> > >
> > >
> > 
> > 
> > 
> > 
> > 
> > __________________________________
> > Do you Yahoo!?
> > Friends.  Fun.  Try the all-new Yahoo! Messenger.
> > http://messenger.yahoo.com/
> 
> 



		
__________________________________
Do you Yahoo!?
Yahoo! Mail Address AutoComplete - You start. We finish.
http://promotions.yahoo.com/new_mail 

RE: API doc generation with Doxygen

Posted by Susantha Kumara <su...@opensource.lk>.
Hi Samisa,

I checked the doxygen comments. But I could not yet locate the problem.
I will try to locate the problem ASAP.

---
Susantha

> -----Original Message-----
> From: Samisa Abeysinghe [mailto:samisa_abeysinghe@yahoo.com]
> Sent: Tuesday, June 15, 2004 1:00 PM
> To: Apache AXIS C Developers List
> Subject: RE: API doc generation with Doxygen
> 
> Hi Susantha,
>     Is it possible for you to fix the problems.
>     I cannot still generate the docs.
> Thanks,
> Samisa
> 
> 
> --- Susantha Kumara <su...@opensource.lk> wrote:
> > Hi Samisa,
> >
> > I think this has happened with my commit with documentation of
Parser
> > and Transport related header files. Actually I did not try to
generate
> > the API documentation with doxygen before commiting. I only compiled
and
> > ran Axis to verify that it works and commited. I apologize for any
> > inconvenience caused.
> >
> > Shall we make the tradition from now on that any developer should
also
> > run doxygen any verify correct API doc generation before commiting.
> >
> >
> > > -----Original Message-----
> > > From: Samisa Abeysinghe [mailto:samisa_abeysinghe@yahoo.com]
> > > Sent: Tuesday, June 15, 2004 8:46 AM
> > > To: Apache AXIS C Developers List
> > > Subject: API doc generation with Doxygen
> > >
> > > Hi,
> > >     I updated the Stub.h and made sure the API doc comments work
with
> > > doxygen.
> > >
> > >     However the latest changes done on the file by someone else
has
> > made
> > > the doxygen tool not to
> > > pick the comments and does not generate properly.
> >
> > That was my mistake. I am sorry for that.
> >
> > >     This is the second time around that the work done by me was
made
> > non
> > > functional. (the earlier
> > > situation was in case of the WSDL2WS tool)
> > >     I think we better have some diciplined testing before commits
are
> > > made.
> >
> > Yes this is not the first time that this has happened. I today found
> > that WSDL2Ws tool does not generate the default constructor of
client
> > side stub with the endpoint taken from the WSDL. Some one has
removed
> > that part of code in WSDL2Ws tool.
> >
> > We have to avoid happening these in the future.
> >
> > >
> > >     In case of doxygen please make sure to verify that documents
are
> > > generated properly.
> > >
> > >     Additionally, I cannot locate docs related to Transport
> > abstraction
> > > and parser abstraction
> > > within the API docs generated.
> > >
> > >     I am kind of frustrated on the amount of rework/rechecks that
I
> > have
> > > to do. Please fix the
> > > Stub/parser abstraction and trasport abstraction documentation, so
> > that
> > > users could program using
> > > those.
> > >
> > > Thanks,
> > > Samisa...
> > >
> >
> > Thanks,
> > --
> > Susantha Kumara
> > Lanka Software Foundation
> > Office : +94112591785
> > Mobile : +94777420453
> >
> >
> 
> 
> 
> 
> 
> __________________________________
> Do you Yahoo!?
> Friends.  Fun.  Try the all-new Yahoo! Messenger.
> http://messenger.yahoo.com/


RE: API doc generation with Doxygen

Posted by Samisa Abeysinghe <sa...@yahoo.com>.
Hi Susantha,
    Is it possible for you to fix the problems.
    I cannot still generate the docs.
Thanks,
Samisa


--- Susantha Kumara <su...@opensource.lk> wrote:
> Hi Samisa,
> 
> I think this has happened with my commit with documentation of Parser
> and Transport related header files. Actually I did not try to generate
> the API documentation with doxygen before commiting. I only compiled and
> ran Axis to verify that it works and commited. I apologize for any
> inconvenience caused.
> 
> Shall we make the tradition from now on that any developer should also
> run doxygen any verify correct API doc generation before commiting. 
> 
> 
> > -----Original Message-----
> > From: Samisa Abeysinghe [mailto:samisa_abeysinghe@yahoo.com]
> > Sent: Tuesday, June 15, 2004 8:46 AM
> > To: Apache AXIS C Developers List
> > Subject: API doc generation with Doxygen
> > 
> > Hi,
> >     I updated the Stub.h and made sure the API doc comments work with
> > doxygen.
> > 
> >     However the latest changes done on the file by someone else has
> made
> > the doxygen tool not to
> > pick the comments and does not generate properly.
> 
> That was my mistake. I am sorry for that.
>  
> >     This is the second time around that the work done by me was made
> non
> > functional. (the earlier
> > situation was in case of the WSDL2WS tool)
> >     I think we better have some diciplined testing before commits are
> > made.
> 
> Yes this is not the first time that this has happened. I today found
> that WSDL2Ws tool does not generate the default constructor of client
> side stub with the endpoint taken from the WSDL. Some one has removed
> that part of code in WSDL2Ws tool.
>  
> We have to avoid happening these in the future.
> 
> > 
> >     In case of doxygen please make sure to verify that documents are
> > generated properly.
> > 
> >     Additionally, I cannot locate docs related to Transport
> abstraction
> > and parser abstraction
> > within the API docs generated.
> > 
> >     I am kind of frustrated on the amount of rework/rechecks that I
> have
> > to do. Please fix the
> > Stub/parser abstraction and trasport abstraction documentation, so
> that
> > users could program using
> > those.
> > 
> > Thanks,
> > Samisa...
> > 
> 
> Thanks,
> --
> Susantha Kumara
> Lanka Software Foundation
> Office : +94112591785
> Mobile : +94777420453
> 
> 



	
		
__________________________________
Do you Yahoo!?
Friends.  Fun.  Try the all-new Yahoo! Messenger.
http://messenger.yahoo.com/ 

RE: API doc generation with Doxygen

Posted by Susantha Kumara <su...@opensource.lk>.
Hi Samisa,

I think this has happened with my commit with documentation of Parser
and Transport related header files. Actually I did not try to generate
the API documentation with doxygen before commiting. I only compiled and
ran Axis to verify that it works and commited. I apologize for any
inconvenience caused.

Shall we make the tradition from now on that any developer should also
run doxygen any verify correct API doc generation before commiting. 


> -----Original Message-----
> From: Samisa Abeysinghe [mailto:samisa_abeysinghe@yahoo.com]
> Sent: Tuesday, June 15, 2004 8:46 AM
> To: Apache AXIS C Developers List
> Subject: API doc generation with Doxygen
> 
> Hi,
>     I updated the Stub.h and made sure the API doc comments work with
> doxygen.
> 
>     However the latest changes done on the file by someone else has
made
> the doxygen tool not to
> pick the comments and does not generate properly.

That was my mistake. I am sorry for that.
 
>     This is the second time around that the work done by me was made
non
> functional. (the earlier
> situation was in case of the WSDL2WS tool)
>     I think we better have some diciplined testing before commits are
> made.

Yes this is not the first time that this has happened. I today found
that WSDL2Ws tool does not generate the default constructor of client
side stub with the endpoint taken from the WSDL. Some one has removed
that part of code in WSDL2Ws tool.
 
We have to avoid happening these in the future.

> 
>     In case of doxygen please make sure to verify that documents are
> generated properly.
> 
>     Additionally, I cannot locate docs related to Transport
abstraction
> and parser abstraction
> within the API docs generated.
> 
>     I am kind of frustrated on the amount of rework/rechecks that I
have
> to do. Please fix the
> Stub/parser abstraction and trasport abstraction documentation, so
that
> users could program using
> those.
> 
> Thanks,
> Samisa...
> 

Thanks,
--
Susantha Kumara
Lanka Software Foundation
Office : +94112591785
Mobile : +94777420453