]> git.ipfire.org Git - thirdparty/kmod.git/commit
Add document for exported enums
authorChengwei Yang <chengwei.yang@intel.com>
Sat, 4 May 2013 09:07:03 +0000 (17:07 +0800)
committerLucas De Marchi <lucas.de.marchi@gmail.com>
Sat, 4 May 2013 21:57:43 +0000 (18:57 -0300)
commitd7152f6282fe10486d41f7917393e3b86c0e5766
tree98cf8f19ecb23d723e30a3d575d541059e23fb16
parent491c490204f72a8eea627bebe25f6d242e4fecb7
Add document for exported enums

There are several exported enums by libkmod without document, this patch
mainly added documentation for below enums like the way kmod_resources
be documented in.
* kmod_index
* kmod_remove
* kmod_insert
* kmod_probe
* kmod_filter
* kmod_module_initstate

This is not the best way to document these exported enums, however, it's
the simple way due to gtkdoc limits. It doesn't support export plain
enum like below: see https://bugzilla.gnome.org/show_bug.cgi?id=657444
---------8<-------head.h--------------8<-----------
...
enum foo {
    ...
};
...
---------8<-------end of head.h-------8<-----------
---------8<-------source.c------------8<-----------
...
/**
 * document for foo here
 */
...
typedef enum foo foo;
...
---------8<-------end of source.c-----8<----------
libkmod/libkmod-module.c
libkmod/libkmod.c