Two line
* > quote
*
* Offsets are time values to be added to local
* time to get Coordinated Universal Time (UTC) and should be
* "[±]hh[[:]mm[:ss]]". Dates are either
* "Jn" (Julian day with n between 1 and 365, leap
* years not counted), "n" (zero-based Julian day
* with n between 0 and 365) or "Mm.w.d" (day d
* (0 <= d <= 6) of week w (1 <= w <= 5) of month m (1 <= m <= 12), day
* 0 is a Sunday). Times are in local wall clock time, the default is
* 02:00:00.
*
* lang_COUNTRY@MODIFIER
* lang_COUNTRY\@MODIFIER
*
* This file contains non-sense code for the sole purpose of testing the docs.
* We can link to the #GtkdocObject:otest property and the #GtkdocObject::otest
* signal.
*
* When subclassing it is useful to override the #GtkdocObjectClass.test()
* method. The #GtkdocObjectClass.foo_bar() vmethod lets you refine your
* frobnicator.
*
* A new instance can be created using the gtkdoc_object_new() function. The
* whole lifecycle usualy looks like shown in this example:
* |[{{!-- language="C" --!}}
* GObject *myobj;
*
* myobj = gtkdoc_object_new();
* // do something
* g_object_unref (myobj);
* ]|
*
* # Examples # {#examples}
*
* Here are a few examples.
*
* ## Example 1 ##
*
* You can also change parameters:
*
*
*
*
* This example serves two main purposes:
*
* - `test`ing conversion (`long description
* follows here`)
*
* - catching bugs
*
* [GTK](http://www.gtk.org) 
*
* - having an example
*
* # Discussion
*
* This is a section with a heading without a trailing hash mark.
*
* > Do not confuse the GtkUIManager UI Definitions described here with
* > the similarly named GtkBuilder UI
* > Definitions.
*
* > Single line quote
*
*
*
* This list is here to ensure the parsing of the above list
*
*
* Doesn't change it.
*
*
*
* This example serves two main purposes:
*
* * testing alternate list syntax
*
* Don't match this as a link [ style | binding ][ : priority ]
*
* * not sure if we want this one
*
* A link
*
* An embedded docbook section
* Some stuff
*
* - A list
*
* - that is not recognised as markdown
*
*
*
* # Coda # {#this-is-an-id-tag}
*
* - One
* - Two
* - Three
*
* 1. This is a ordered list
*
* 1. This is a code block in a list:
* |[{{!-- language="C" --!}}
* GObject *myobj;
*
* myobj = gtkdoc_object_new();
* // do something
* g_object_unref (myobj);
* ]|
* And another:
* |[{{!-- language="C" --!}}
* GObject *myobj;
*
* myobj = gtkdoc_object_new();
* /* do something */
* g_object_unref (myobj);
* ]|
*
* 1. Really
*
* Has a paragraph with a [link to the examples][examples].
*
* 1. Is
*
* Nothing more to say. Except one more link:
*
*
*
*/]]>
SECTION:objecttitleGtkdocObjectshort_descriptionclass for gtk-doc unit testsee_also#GtkdocIfaceImageobject.png Two line
> quote
Offsets are time values to be added to local
time to get Coordinated Universal Time (UTC) and should be
"[±]hh[[:]mm[:ss]]". Dates are either
"Jn" (Julian day with n between 1 and 365, leap
years not counted), "n" (zero-based Julian day
with n between 0 and 365) or "Mm.w.d" (day d
(0 <= d <= 6) of week w (1 <= w <= 5) of month m (1 <= m <= 12), day
0 is a Sunday). Times are in local wall clock time, the default is
02:00:00.
lang_COUNTRY@MODIFIERlang_COUNTRY\@MODIFIER
This file contains non-sense code for the sole purpose of testing the docs.
We can link to the #GtkdocObject:otest property and the #GtkdocObject::otest
signal.
When subclassing it is useful to override the #GtkdocObjectClass.test()
method. The #GtkdocObjectClass.foo_bar() vmethod lets you refine your
frobnicator.
A new instance can be created using the gtkdoc_object_new() function. The
whole lifecycle usualy looks like shown in this example:
|[{{!-- language="C" --!}}
GObject *myobj;
myobj = gtkdoc_object_new();
// do something
g_object_unref (myobj);
]|
# Examples # {#examples}
Here are a few examples.
## Example 1 ##
You can also change parameters:
This example serves two main purposes:
- `test`ing conversion (`long description
follows here`)
- catching bugs
[GTK](http://www.gtk.org) 
- having an example
# Discussion
This is a section with a heading without a trailing hash mark.
> Do not confuse the GtkUIManager UI Definitions described here with
> the similarly named GtkBuilder UI
> Definitions.
> Single line quote
This list is here to ensure the parsing of the above list
Doesn't change it.
This example serves two main purposes:
* testing alternate list syntax
Don't match this as a link [ style | binding ][ : priority ]
* not sure if we want this one
A link An embedded docbook sectionSome stuff
- A list
- that is not recognised as markdown
# Coda # {#this-is-an-id-tag}
- One
- Two
- Three
1. This is a ordered list
1. This is a code block in a list:
|[{{!-- language="C" --!}}
GObject *myobj;
myobj = gtkdoc_object_new();
// do something
g_object_unref (myobj);
]|
And another:
|[{{!-- language="C" --!}}
GObject *myobj;
myobj = gtkdoc_object_new();
/* do something */
g_object_unref (myobj);
]|
1. Really
Has a paragraph with a [link to the examples][examples].
1. Is
Nothing more to say. Except one more link:
]]>
/**
* SECTION:object2
* @title: GtkdocObject2
* @short_description: class with interface for gtk-doc unit test
* @see_also: #GtkdocIface
*
* This file contains non-sense code for the sole purpose of testing the docs.
*
* Internals
* =========
*
* All the internal details go here or not:
*
* - single item list
*/
SECTION:object2titleGtkdocObject2short_descriptionclass with interface for gtk-doc unit testsee_also#GtkdocIfaceThis file contains non-sense code for the sole purpose of testing the docs.
Internals
=========
All the internal details go here or not:
- single item list
/**
* SECTION:object3
* @title: GtkdocObject3
* @short_description: class that is mostly undocumented
*
* This file contains non-sense code for the sole purpose of testing the docs.
*/
SECTION:object3titleGtkdocObject3short_descriptionclass that is mostly undocumentedThis file contains non-sense code for the sole purpose of testing the docs.
* This will only work if you have called g_type_init() before.
*
*
* Returns: the instance or %NULL in case of an error
* Since: 0.1
*/]]>
gtkdoc_object_new
This will only work if you have called g_type_init() before.
]]>returnsthe instance or %NULL in case of an errorsince0.1gtkdoc_object_set_otestselfthe objectvaluethe new otest value, whose description extends further than one
line will allowSet the #GtkdocObject:otest property. This is a long paragraph.
Oh, btw. setting the property directly saves us one method.deprecatedsince0.5
*
* Negative frobnication can lead to unexpected behaviour.
*
*
*
* Since: 0.5
*/]]>
gtkdoc_object_frobnicateselfthe objectnnumber of iterations
Negative frobnication can lead to unexpected behaviour.
]]>since0.5
/**
* gtkdoc_object_fooify:
* @self: the object
* @...: a NULL terminated list of arguments
*
* Fooify the content of @self.
*
* Returns: %TRUE for success
*/
gtkdoc_object_fooifyselfthe object...a NULL terminated list of argumentsFooify the content of @self.returns%TRUE for success
/**
* gtkdoc_object_do_not_use:
* @self: the object
*
* Test a deprecation without additional message.
*
* Deprecated: 3.10
*/
gtkdoc_object_do_not_useselfthe objectTest a deprecation without additional message.deprecated3.10
/**
* GtkdocObject::otest:
* @self: myself
*
* The event has been triggered.
*/
GtkdocObject::otestselfmyselfThe event has been triggered.
/**
* GtkdocObject::dep-otest:
* @self: myself
*
* Here's an example signal handler.
* |[
* static gchar*
* otest_callback (GObject *o,
* gpointer user_data)
* {
* gdouble value;
*
* value = abs (o->value);
*
* return value;
* }
* ]|
*
* Deprecated: Use the #GtkdocObject::otest signal instead.
*/
GtkdocObject::dep-otestselfmyselfHere's an example signal handler.
|[
static gchar*
otest_callback (GObject *o,
gpointer user_data)
{
gdouble value;
value = abs (o->value);
return value;
}
]|deprecatedUse the #GtkdocObject::otest signal instead.
/**
* GtkdocObject::strings-changed:
*
* Something has happened.
*/
GtkdocObject::strings-changedSomething has happened.
/**
* GtkdocObject::variant-changed:
*
* Something has happened.
*/
GtkdocObject::variant-changedSomething has happened.
/**
* GtkdocObject:otest: (type GList(GtkdocObject2))
*
* Since: 0.1
*/
GtkdocObject:otesttypesince0.1
/**
* GtkdocObject:dep-otest:
*
* Deprecated: use #GtkdocObject:otest property
*/
GtkdocObject:dep-otestdeprecateduse #GtkdocObject:otest property