[Evolution-hackers] Adding documentation to Evolution's code

2006-08-09 Thread Mayank Jain
Hi all,

When I started working on Evolution, all I had was
http://www.go-evolution.org/index.php/Evolution_Architecture as a
reference document  lots  lots of code to read. It would have been
easier if the code was more documented.

With that in mind, I would like to add more documentation, comments
(with whatever knowledge I have) to the code.

This documentation can be like a header to functions like...

/
Use - describe the function in 2-3 lines
Input - input args
Output - return values
/

And it can be comments inside the function, describing what is happening  how.

If the comments can then be reviewed by an existing developer, i'm
sure, they'll serve as a solid head start to a new developer.

Let me know what is the best way of taking this forward...
- Do it through a bug ID per component (for the component I know)
- Keep the discussion to mailing list  ping the relevent developer
when my work is done
- Any other way...

Thanks,
Makuchaku
http://makuchaku.info
___
Evolution-hackers mailing list
Evolution-hackers@gnome.org
http://mail.gnome.org/mailman/listinfo/evolution-hackers


Re: [Evolution-hackers] Adding documentation to Evolution's code

2006-08-09 Thread Matthew Barnes
On Wed, 2006-08-09 at 17:43 +0530, Mayank Jain wrote:
 This documentation can be like a header to functions like...
 
 /
 Use - describe the function in 2-3 lines
 Input - input args
 Output - return values
 /

Probably want to stick to a format that GTK-Doc [1] can parse.

For example:

/**
 * function_name:
 * @arg1: description of arg1
 * @arg2: description of arg2
 *
 * Description of function, possibly mentioning @arg1 and @arg2,
 * as well as some other #documented_symbol.
 *
 * Return value: description of the result
 **/

The GTK+ and GLib source code have plenty of good examples.

[1] http://www.gtk.org/gtk-doc/

Matthew Barnes

___
Evolution-hackers mailing list
Evolution-hackers@gnome.org
http://mail.gnome.org/mailman/listinfo/evolution-hackers


[Evolution-hackers] Converting vevent components into one vcalendar component

2006-08-09 Thread Teresa Thomas
I intend to use the function void icalcomponent_merge_component(icalcomponent* comp, icalcomponent* comp_to_merge); to merge two VCALENDAR components.When I query for all the objects in an Evo cal, what I get is a list of icalcomponent. I want to convert this bunch of VEVENT icalcomponents into a single VCALENDAR icalcomponent so that I can use the above mentioned function. Ofcourse, I could convert them into strings first and manually concatenate the objects, but is there a better way to do this?
Thanks!Teresa
___
Evolution-hackers mailing list
Evolution-hackers@gnome.org
http://mail.gnome.org/mailman/listinfo/evolution-hackers


[Evolution-hackers] how to attach addressbook?

2006-08-09 Thread 黄冠能
Hi,

After reading part of the source Evolution, I know I should call
functions in e-book.h and some other relative. I can import contact to
system addressbook now. I want to create a new addressbook, the
procedure is as follow:

- part of the source -
EBook *newBook = e_book_new_from_uri (uri, NULL);
e_book_open(newBook, FALSE, NULL);
e_book_add_contact(newBook, contact, NULL);
ESource *newBookSource = e_book_get_source(newBook);
e_source_set_name(newBookSource, test3);

ESourceGroup *group = E_SOURCE_GROUP(g-data);
e_source_set_group(newBookSource, group);
e_source_group_add_source(group, newBookSource, 1);
---

test3 was create in .evolution/addressbook/local/ and contacts was
add the addressbook.db. The problem is when I open Evolution, the
addressbook is not display in the list. Have I forgotten to do something?

Many many thanks!!

 Hey all.

 I am new to Evolution. I want to write a script to import contacts(vcard
 or ldif format) automaticly without opening Evolution. How can I do it?
 Is there a *.so file that includes this function? If so, how do I know
 the usage.

 Many many thanks:)

 Cameron Wong
   
 

 ___
 Evolution-hackers mailing list
 Evolution-hackers@gnome.org
 http://mail.gnome.org/mailman/listinfo/evolution-hackers
   


-- 
黄冠能
广东省LINUX公共服务技术支持中心
地址:广州市天河区水荫路115号天溢大厦A区四楼
电话:020-87048510/87048516 转2655
手机:13430266433
[EMAIL PROTECTED]

___
Evolution-hackers mailing list
Evolution-hackers@gnome.org
http://mail.gnome.org/mailman/listinfo/evolution-hackers


Re: [Evolution-hackers] Converting vevent components into one vcalendar component

2006-08-09 Thread chenthill
Hi teresa,
You can probably create a toplevel VCALENDAR component using
e_cal_util_new_top_level () and add the VEVENT components to it using
icalcomponent_add_component. Hope this answers your question.


- Chenthill.
On Wed, 2006-08-09 at 15:44 -0400, Teresa Thomas wrote:
 I intend to use the function 
 void icalcomponent_merge_component(icalcomponent* comp, icalcomponent*
 comp_to_merge); 
 to merge two VCALENDAR components.
 
 When I query for all the objects in an Evo cal, what I get is a list
 of icalcomponent. I want to convert this bunch of VEVENT
 icalcomponents into a single VCALENDAR icalcomponent so that I can use
 the above mentioned function. Ofcourse, I could convert them into
 strings first and manually concatenate the objects, but is there a
 better way to do this? 
 
 Thanks!
 
 Teresa

___
Evolution-hackers mailing list
Evolution-hackers@gnome.org
http://mail.gnome.org/mailman/listinfo/evolution-hackers