Re: [Evolution-hackers] Any documentation around anywhere?

2002-06-14 Thread NotZed



On 13 Jun 2002, Joe Khoobyar wrote:

 Hi everyone.  I just recently subscribed to this list because I'd really
 love to customize and add some features to Evolution.  I'm a
 professional software developer and I've been writing code since I was
 ten, so I'm not out of my element or anything.

Ha!  Are you sure mate?  We're kinda 1337 aroun here you might not be up
to speed :)  (i'm totally joking of course!)

 However, I was wondering if there was any documentation lying around
 about the class hierarchy in Evolution?  I figured if there was, it
 would save me a lot of time tooling around to figure out the basic
 structure of things.  Unfortunately, free time is something that can be
 pretty elusive.

 I know we all hate documenting code (at least I do) so it's probably
 likely that it hasn't been done yet, but I was hoping against hope that
 there might be some docs out there already?

There are a ew bits and pieces, but not a whole hell of a lot :(  there's
some stuff in camel/devel-docs, but a lot of it is a bit out of date, and
only relevent if you're interested in low-level email stuff.

Unofortunately for most things you have to resort to the source.  Although
at least the coba compnent like wombat (addressbook/calendar) are wrapped
in corba idl's.

  --
 Joe Khoobyar
 Ankhcraft
 where technology is our art
 http://www.ankhcraft.com
 Voice: (703) 200-7871
 Fax:   (703) 941-1175


 ___
 evolution-hackers maillist  -  [EMAIL PROTECTED]
 http://lists.ximian.com/mailman/listinfo/evolution-hackers



___
evolution-hackers maillist  -  [EMAIL PROTECTED]
http://lists.ximian.com/mailman/listinfo/evolution-hackers



Re: [Evolution-hackers] Any documentation around anywhere?

2002-06-14 Thread Jeffrey Stedfast

We already have something like this called GtkDoc - and the inline
comments in Camel already contain comments in the correct format in
order to be extracted by the tool, but someone has to go and setup the
makefiles to do it.

Jeff

On Fri, 2002-06-14 at 16:50, A. Lloyd Flanagan wrote:
 I'd like to suggest that for the future we might want to use a tool like
 javadoc.  This would allow the documentation for the classes/functions
 to be included in the source code and automatically extracted to HTML. 
 This is a great way to the basic documentation for the classes, although
 you still have to do overviews, how-tos, etc.
 A tool that does javadoc-like doc generation for C++ is CCDoc, found at 
 http://www.joelinoff.com/ccdoc/.  I don't know of a tool for C/Cobra
 code, although it shouldn't be too hard to do one.
 
 
 On Thu, 2002-06-13 at 23:47, Joe Khoobyar wrote:
  .
 .
  .
 However, I was wondering if there was any documentation lying around
 about the class hierarchy in Evolution?  I figured if there was, it
 would save me a lot of time tooling around to figure out the basic
 structure of things.  Unfortunately, free time is something that can be
 pretty elusive.
 
 
 ___
 evolution-hackers maillist  -  [EMAIL PROTECTED]
 http://lists.ximian.com/mailman/listinfo/evolution-hackers
 
 
 
 
 ___
 evolution-hackers maillist  -  [EMAIL PROTECTED]
http://lists.ximian.com/mailman/listinfo/evolution-hackers
-- 
Jeffrey Stedfast [EMAIL PROTECTED]
Ximian, Inc.


___
evolution-hackers maillist  -  [EMAIL PROTECTED]
http://lists.ximian.com/mailman/listinfo/evolution-hackers



Re: [Evolution-hackers] Any documentation around anywhere?

2002-06-14 Thread A. Lloyd Flanagan

I'd like to suggest that for the future we might want to use a tool like
javadoc.  This would allow the documentation for the classes/functions
to be included in the source code and automatically extracted to HTML. 
This is a great way to the basic documentation for the classes, although
you still have to do overviews, how-tos, etc.
A tool that does javadoc-like doc generation for C++ is CCDoc, found at 
http://www.joelinoff.com/ccdoc/.  I don't know of a tool for C/Cobra
code, although it shouldn't be too hard to do one.


On Thu, 2002-06-13 at 23:47, Joe Khoobyar wrote:
 .
.
 .
However, I was wondering if there was any documentation lying around
about the class hierarchy in Evolution?  I figured if there was, it
would save me a lot of time tooling around to figure out the basic
structure of things.  Unfortunately, free time is something that can be
pretty elusive.


___
evolution-hackers maillist  -  [EMAIL PROTECTED]
http://lists.ximian.com/mailman/listinfo/evolution-hackers




___
evolution-hackers maillist  -  [EMAIL PROTECTED]
http://lists.ximian.com/mailman/listinfo/evolution-hackers