diff options
| author | Matthew Booth <mbooth@redhat.com> | 2012-03-27 09:50:42 +0100 |
|---|---|---|
| committer | Matthew Booth <mbooth@redhat.com> | 2012-03-28 20:04:21 +0100 |
| commit | 321748d3c2313c159cbbe5f154e36a073a6a84b1 (patch) | |
| tree | 9fe2519cff8a24d74258aae224f8198648b5b449 | |
| parent | e49bd34fb7e2c2bd66cf83797af2656b1a2d44b2 (diff) | |
| download | libguestfs-321748d3c2313c159cbbe5f154e36a073a6a84b1.tar.gz libguestfs-321748d3c2313c159cbbe5f154e36a073a6a84b1.tar.xz libguestfs-321748d3c2313c159cbbe5f154e36a073a6a84b1.zip | |
gobject: Add gtk-doc field descriptions for generated structs
| -rw-r--r-- | generator/generator_gobject.ml | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/generator/generator_gobject.ml b/generator/generator_gobject.ml index d536907c..44e86e02 100644 --- a/generator/generator_gobject.ml +++ b/generator/generator_gobject.ml @@ -194,6 +194,31 @@ let generate_gobject_header_structs () = List.iter ( fun (typ, cols) -> let camel = camel_name_of_struct typ in + pr "/**\n"; + pr " * Guestfs%s:\n" camel; + List.iter ( + function + | n, FChar -> + pr " * @%s: A character\n" n + | n, FUInt32 -> + pr " * @%s: An unsigned 32-bit integer\n" n + | n, FInt32 -> + pr " * @%s: A signed 32-bit integer\n" n + | n, (FUInt64|FBytes) -> + pr " * @%s: An unsigned 64-bit integer\n" n + | n, FInt64 -> + pr " * @%s: A signed 64-bit integer\n" n + | n, FString -> + pr " * @%s: A NULL-terminated string\n" n + | n, FBuffer -> + pr " * @%s: A GByteArray\n" n + | n, FUUID -> + pr " * @%s: A 32 byte UUID. Note that this is not NULL-terminated\n" n + | n, FOptPercent -> + pr " * @%s: A floating point number. A value between 0 and 100 " n; + pr "represents a percentage. A value of -1 represents 'not present'\n" + ) cols; + pr " */\n"; pr "typedef struct _Guestfs%s Guestfs%s;\n" camel camel; pr "struct _Guestfs%s {\n" camel; List.iter ( |