From babf85c175e090f59f26b7af7579811687303129 Mon Sep 17 00:00:00 2001 From: Romain B Date: Sun, 17 Sep 2017 17:24:32 +0200 Subject: Document all functions inside c-source - Taken from old sgml template - Less compilation warnings now --- thunarx/thunarx-property-page.c | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) (limited to 'thunarx/thunarx-property-page.c') diff --git a/thunarx/thunarx-property-page.c b/thunarx/thunarx-property-page.c index aec8e6a4..a62bddff 100644 --- a/thunarx/thunarx-property-page.c +++ b/thunarx/thunarx-property-page.c @@ -31,7 +31,30 @@ #define THUNARX_PROPERTY_PAGE_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), THUNARX_TYPE_PROPERTY_PAGE, ThunarxPropertyPagePrivate)) - +/** + * SECTION: thunarx-property-page + * @short_description: The base class for pages added to the properties dialog + * @title: ThunarxPropertyPage + * @include: thunarx/thunarx.h + * + * The class for pages that can be added to Thunar's file properties dialog + * by extensions implementing the #ThunarxPropertyPageProvider interface. The + * pages returned by extensions from thunarx_property_page_provider_get_pages() + * method are instances of this class or a derived class. Note that extensions + * do not need to subclass #ThunarxPropertyPage, but may also instantiate it + * directly and add widgets to it, but I strongly suggest to create a subclass + * as it usually leads to better modularization and thereby better maintainability + * in the code. + * + * To pick up the #TagPage example from the thunarx_property_page_provider_get_pages() + * description again, you'd create a new class #TagPage, that inherits #ThunarxPropertyPage + * (using the #THUNARX_DEFINE_TYPE macro), which provides several user interface elements + * in the property, and defines atleast one property named "file", which + * is the #ThunarxFileInfo whose tags are displayed in the property page. For example, the + * tag-page.h header file would look like this (this is really just + * an example of the suggested way to implement property pages, you may of course choose + * a different way) + */ /* Property identifiers */ enum -- cgit v1.2.1