Property documentation of mock

Properties

Details

name

Enum name	Value
`UCA_CAMERA_TRIGGER_AUTO`	0
`UCA_CAMERA_TRIGGER_SOFTWARE`	1
`UCA_CAMERA_TRIGGER_EXTERNAL`	2

diff --git a/docs/style.css b/docs/style.css index beccf45..41651e1 100644 --- a/docs/style.css +++ b/docs/style.css @@ -140,8 +140,9 @@ ol ol { } table { - width: 100%; + margin-top: 1em; margin-bottom: 24px; + padding: 1em; } th { @@ -152,7 +153,9 @@ th { } td, th { - padding: 2px; + padding-right: 1em; + padding-top: 0.5em; + padding-bottom: 0.5em; } dl { diff --git a/tools/gen-doc.c b/tools/gen-doc.c index f555a5f..eb61cc9 100644 --- a/tools/gen-doc.c +++ b/tools/gen-doc.c @@ -67,31 +67,100 @@ print_property_toc (GParamSpec **pspecs, guint n_props) g_print ("

Properties

\"%s\"

"); } +static void +print_value_info (GParamSpec *pspec) +{ + gchar *default_value = NULL; + GString *range = g_string_new(""); + +#define MAKE_RANGE(spec_type, fmt) \ + { \ + spec_type *spec = (spec_type *) pspec; \ + g_string_printf (range, \ + fmt" ≤ %s ≤ "fmt, \ + spec->minimum, \ + g_param_spec_get_name (pspec), \ + spec->maximum); \ + default_value = g_strdup_printf (fmt, spec->default_value); \ + } + + switch (pspec->value_type) { + case G_TYPE_BOOLEAN: + { + GParamSpecBoolean *spec = (GParamSpecBoolean *) pspec; + default_value = spec->default_value ? g_strdup ("TRUE") : g_strdup ("FALSE"); + } + break; + + case G_TYPE_UINT: + MAKE_RANGE (GParamSpecUInt, "%i"); + break; + + case G_TYPE_FLOAT: + MAKE_RANGE (GParamSpecFloat, "%.1e"); + break; + + case G_TYPE_DOUBLE: + MAKE_RANGE (GParamSpecDouble, "%.1e"); + break; + } + +#undef MAKE_RANGE + + if (g_type_is_a (pspec->value_type, G_TYPE_ENUM)) { + GParamSpecEnum *spec = (GParamSpecEnum *) pspec; + + if (spec->enum_class->n_values > 0) { + g_string_printf (range, ""); + + for (guint i = 0; i < spec->enum_class->n_values; i++) { + GEnumValue *v = &spec->enum_class->values[i]; + g_string_append_printf (range, + "", + v->value_name, v->value); + } + + g_string_append_printf (range, "

Enum name	Value
`%s`	%i

"); + } + } + + if (range->len > 0) + g_print ("

Possible values: %s

", range->str); + + if (default_value != NULL) { + g_print ("

Default value: %s

", default_value); + g_free (default_value); + } + + g_string_free (range, TRUE); +} + static void print_property_descriptions (GParamSpec **pspecs, guint n_props) { g_print ("

Details

%s

"); - g_print ("

\"%s\" : %s : %s

\n", - name, + g_print ("

\"%s\" : %s : %s

\n", + name, g_type_name (pspec->value_type), get_flags_description (pspec)); g_print ("

\n", g_param_spec_get_blurb (pspec)); + print_value_info (pspec); g_print ("

Property documentation of mock

Properties

Details

Property documentation of Basic camera

Properties

Details

Properties

Details