[Xcb] doxygen doc of the API

[Vincent Torri]

Here is the updated doc (no todo for the XCBFlush returned value)

Vincent

On Sat, 4 Mar 2006, Vincent Torri wrote:

>
> Hey,
>
> Here is the modified file. I have added the const for the returned value
> of XCBGetSetup.
>
> > Note that XCBGenericRep is a generic reply, not a generic response. The
> > term "response" is used to refer to any reply, error, or event.
>
> i've fixed that
>
> >
> > Were you planning on including documentation on internal APIs here? If
> > not, it's kind of weird that the file list has xcbint.h and all the
> > source files. It should arguably cover only xcb.h, xcbext.h, and
> > xcbxlib.h. Possibly it should also cover xproto.h and others, but only
> > if you can auto-generate part or all of that documentation from the
> > original XML.
>
> No, i didn't want that. It's only doxygen that have added it. It's just
> something to tweak in the configuration file that generate the doc. Not a
> big stuff.
>
> > >  i also would like to add some presentation on the main page. For example:
> > >
> > >  * general presentation (from the wiki)
> > >  * a small example of code
> > >  * something else ?
> >
> > I think your tutorial is the place for code samples, etc. A link to your
> > tutorial wouldn't be a bad thing for the main page of the API
> > documentaiton though.
>
> ok
>
> > >  we can add some todo items, if some functions need to.
> >
> > I'm not sure I understand this. You mean if the functions have planned
> > interface changes? At this point, if I could remember that I planned to
> > change the interface, I've done it already.
>
> with doxygen, we can add "todo" items, that is, we can add a @todo
> paragraph somewhere, and doxygen adds a page with all the todo.
> But, nevermind, i've added  the 2 todo in bugzilla :) I've let them in
> xcb.h.diff, though.
>
> Now, we should choose between 2 solutions for the documentation:
>
> 1) we add
> documentation in each module (xcb(code), xcb-proto, xcb-utils)  and
> generate the doc in each of them.
>
> 2) we add the doc in each module, and we place all the doc in one place
> (and we define groups, like i've done in xcb.h, see the beginning of the
> file)
>
> what do you think ?
>
> Vincent
-------------- next part --------------
--- xcbint.h	2006-03-04 10:01:35.681578751 +0100
+++ xcbint.h.old	2006-03-04 09:43:01.860275538 +0100
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2001-2004 Bart Massey and Jamey Sharp.
+ * Copyright (C) 2001-2006 Bart Massey and Jamey Sharp.
  * All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a
@@ -8,17 +8,17 @@
  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  * and/or sell copies of the Software, and to permit persons to whom the
  * Software is furnished to do so, subject to the following conditions:
- * 
+ *
  * The above copyright notice and this permission notice shall be included in
  * all copies or substantial portions of the Software.
- * 
+ *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  * AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- * 
+ *
  * Except as contained in this notice, the names of the authors or their
  * institutions shall not be used in advertising or otherwise to promote the
  * sale, use or other dealings in this Software without prior written
@@ -32,6 +32,10 @@
 #include "config.h"
 #endif
 
+#ifdef GCC_HAS_VISIBILITY
+#pragma GCC visibility push(hidden)
+#endif
+
 enum workarounds {
     WORKAROUND_NONE,
     WORKAROUND_GLX_GET_FB_CONFIGS_BUG
@@ -153,4 +157,9 @@
 };
 
 int _xcb_conn_wait(XCBConnection *c, const int should_write, pthread_cond_t *cond);
+
+#ifdef GCC_HAS_VISIBILITY
+#pragma GCC visibility pop
+#endif
+
 #endif