Ticket #946 (new defect)

Opened 5 years ago

Last modified 5 years ago

state which file to include

Reported by: mkoller Owned by: bricks
Priority: high Milestone: OpenSync 0.40
Component: OpenSync: API Documentation Version: 0.38
Severity: normal Keywords:
Cc: paule

Description

I'm looking for what I need to include to be able to use e.g. osync_hashtable_new() So I look in the API docs and find a module named "OpenSync? Hashtables" which sounds promising. Going to that page http://www.opensync.org/doxygen/group__OSyncHashtableAPI.html shows me the function I was looking for. Great! But: what include do I need to put into my implementation to get it ? The line "Definition at line 237 of file opensync_hashtable.c." does not help me anything as I want to use the function but not checking it's implementation.

So what is needed is the header filename to include.

For a very good style of documentation, please have a look at e.g. http://doc.trolltech.com/4.4/qpen.html In the very first few lines I already know what to include to be able to use a functionality.

Change History

comment:1 Changed 5 years ago by dgollub

  • Cc paule added

The include answer for a plugin is the "high-level"-header for the "helper" component: <opensync/opensync-helper.h

Please include #include <opensync/opensync-helper.h

Indeed, the Qt API documentation is one of the best i have seen so far. Very likely that's also the reason why it's so easy to write Qt stuff :)

Tuju or Paul, could define some API guidelines so we get close to a state were the Qt API documentation is?

I create for this a wiki-page were we can draft such API guideline?.

(I'm talking not about fancy graphical layout - it's more about the content)

comment:2 Changed 5 years ago by bricks

  • Owner changed from tuju to bricks
Note: See TracTickets for help on using tickets.