[pLog-svn] r6088 - plog/branches/lifetype-1.2/class/security

[Oscar Renalias]

I think we all understand what you set out to accomplish, but we're  
just wondering about two things: 1) what kind of XML output do you  
need and 2) can it be automated so that it can be easily maintained?

In our case, we use Doxygen to generate the HTML documentation based  
on the comments in our code. Doxygen (http://www.doxygen.org) is an  
open source tool that works very much like Javadoc or whatever  
solution is available for C#, and it also supports several different  
output backends. If you have the time, you could have a look and see  
whether Doxygen has an XML backend and if the output that it generates  
can be adaped to suit your needs.

Oscar

On Jan 7, 2008, at 5:23 PM, Andy wrote:

> For example: AdminAddUserAction Class Reference
>
> -- NO XML for 3rd party development: I have to personally reference  
> all 
> public attributes, and all the member functions, from you web based
> reference.  If I want to perform an action with C# code, I would  
> have to
> browse your resources in order to find and define all requirements by
> hand.
>
> -- YES XML
> Your online documentation is indexed for DEVELOPERS whom can parse the
> class requirements and create a function -to setup- all the data  
> types,
> of any class, a local XML file with references of the purpose, and
> virables that would be parsed - all API requirements declared, and  
> just a
> call to the function would make this process automatic.
>
> I use VS for my IDE, and call an API resource using my costome  
> function,
> references to the XML file are automatically displayed, browsable, and
> searchable.
>
> Imagine defining 8 public attributes for one call that would not be  
> re-usable
> code.  What a mess!
>
> I am sorry you are having a hard time understanding what I was to
> accomplish.  But I will not give up, let me know and I will put it in
> different words.
>
> Andy
>
> On Mon, 7 Jan 2008, Mark Wu wrote:
>
>> Yep, I has the same concern, too.
>>
>> Mark
>>
>>> -----Original Message-----
>>> From: plog-svn-bounces at devel.lifetype.net
>>> [mailto:plog-svn-bounces at devel.lifetype.net] On Behalf Of Jon Daley
>>> Sent: Monday, January 07, 2008 10:36 PM
>>> To: LifeType Developer List
>>> Subject: Re: [pLog-svn] r6088 -
>>> plog/branches/lifetype-1.2/class/security
>>>
>>> On Mon, 7 Jan 2008, Andy wrote:
>>>> As of now, I am taking a long route and entering all API data. I am
>>>> doing this for the primary functions, so I know exactly what I am
>>>> doing when I need access to these resources.
>>> 	What does your documentation provide that ours doesn't?
>>> Perhaps it would be better to added something to the doxygen
>>> docs, rather than a separate doc?
>>> http://lifetype.net/api/
>>> _______________________________________________
>>> pLog-svn mailing list
>>> pLog-svn at devel.lifetype.net
>>> http://limedaley.com/mailman/listinfo/plog-svn
>>
>> _______________________________________________
>> pLog-svn mailing list
>> pLog-svn at devel.lifetype.net
>> http://limedaley.com/mailman/listinfo/plog-svn
>>
> _______________________________________________
> pLog-svn mailing list
> pLog-svn at devel.lifetype.net
> http://limedaley.com/mailman/listinfo/plog-svn