diff options
author | Matthew Barnes <mbarnes@redhat.com> | 2010-03-22 02:33:38 +0800 |
---|---|---|
committer | Michael Meeks <michael.meeks@novell.com> | 2010-04-07 19:13:25 +0800 |
commit | c675132de1981a140cf3341b7b1c3cd08862b54b (patch) | |
tree | 93012f4996ebbaf5383b235d7942272f1fced5d2 /doc/reference | |
parent | b674497bccae2ec2ac914714d34961a9517a8aa7 (diff) | |
download | gsoc2013-evolution-c675132de1981a140cf3341b7b1c3cd08862b54b.tar.gz gsoc2013-evolution-c675132de1981a140cf3341b7b1c3cd08862b54b.tar.zst gsoc2013-evolution-c675132de1981a140cf3341b7b1c3cd08862b54b.zip |
Document EExtensible and EExtension.
The mechanism here is simple but hard to explain without leaning heavily
on object-oriented jargon. Consider this a rough draft. Illustrations
would certainly help clarify.
Diffstat (limited to 'doc/reference')
-rw-r--r-- | doc/reference/shell/eshell-docs.sgml | 2 | ||||
-rw-r--r-- | doc/reference/shell/eshell-sections.txt | 34 | ||||
-rw-r--r-- | doc/reference/shell/eshell.types | 2 | ||||
-rw-r--r-- | doc/reference/shell/tmpl/e-extensible.sgml | 33 | ||||
-rw-r--r-- | doc/reference/shell/tmpl/e-extension.sgml | 39 |
5 files changed, 110 insertions, 0 deletions
diff --git a/doc/reference/shell/eshell-docs.sgml b/doc/reference/shell/eshell-docs.sgml index 99948f5007..96fae1a057 100644 --- a/doc/reference/shell/eshell-docs.sgml +++ b/doc/reference/shell/eshell-docs.sgml @@ -34,6 +34,8 @@ <xi:include href="xml/e-categories-config.xml"/> <xi:include href="xml/e-datetime-format.xml"/> <xi:include href="xml/e-dialog-utils.xml"/> + <xi:include href="xml/e-extensible.xml"/> + <xi:include href="xml/e-extension.xml"/> <xi:include href="xml/e-html-utils.xml"/> <xi:include href="xml/e-icon-factory.xml"/> <xi:include href="xml/e-logger.xml"/> diff --git a/doc/reference/shell/eshell-sections.txt b/doc/reference/shell/eshell-sections.txt index be5171cb3d..776d08d13f 100644 --- a/doc/reference/shell/eshell-sections.txt +++ b/doc/reference/shell/eshell-sections.txt @@ -441,6 +441,40 @@ e_dialog_combo_box_get </SECTION> <SECTION> +<FILE>e-extensible</FILE> +<TITLE>Extensible</TITLE> +EExtensible +e_extensible_load_extensions +<SUBSECTION Standard> +E_EXTENSIBLE +E_IS_EXTENSIBLE +E_TYPE_EXTENSIBLE +E_EXTENSIBLE_INTERFACE +E_IS_EXTENSIBLE_INTERFACE +E_EXTENSIBLE_GET_INTERFACE +EExtensibleInterface +e_extensible_get_type +</SECTION> + +<SECTION> +<FILE>e-extension</FILE> +<TITLE>Extensions</TITLE> +EExtension +e_extension_get_extensible +<SUBSECTION Standard> +E_EXTENSION +E_IS_EXTENSION +E_TYPE_EXTENSION +E_EXTENSION_CLASS +E_IS_EXTENSION_CLASS +E_EXTENSION_GET_CLASS +EExtensionClass +e_extension_get_type +<SUBSECTION Private> +EExtensionPrivate +</SECTION> + +<SECTION> <FILE>e-html-utils</FILE> <TITLE>Text to HTML Conversion</TITLE> E_TEXT_TO_HTML_PRE diff --git a/doc/reference/shell/eshell.types b/doc/reference/shell/eshell.types index ae84ef0905..b5c41aecf6 100644 --- a/doc/reference/shell/eshell.types +++ b/doc/reference/shell/eshell.types @@ -1,4 +1,6 @@ e_bit_array_get_type +e_extensible_get_type +e_extension_get_type e_logger_get_type e_module_get_type e_signature_get_type diff --git a/doc/reference/shell/tmpl/e-extensible.sgml b/doc/reference/shell/tmpl/e-extensible.sgml new file mode 100644 index 0000000000..de8e8e140c --- /dev/null +++ b/doc/reference/shell/tmpl/e-extensible.sgml @@ -0,0 +1,33 @@ +<!-- ##### SECTION Title ##### --> +Extensible + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EExtensible ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION e_extensible_load_extensions ##### --> +<para> + +</para> + +@extensible: + + diff --git a/doc/reference/shell/tmpl/e-extension.sgml b/doc/reference/shell/tmpl/e-extension.sgml new file mode 100644 index 0000000000..e1acb9d8e2 --- /dev/null +++ b/doc/reference/shell/tmpl/e-extension.sgml @@ -0,0 +1,39 @@ +<!-- ##### SECTION Title ##### --> +Extensions + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EExtension ##### --> +<para> + +</para> + + +<!-- ##### ARG EExtension:extensible ##### --> +<para> + +</para> + +<!-- ##### FUNCTION e_extension_get_extensible ##### --> +<para> + +</para> + +@extension: +@Returns: + + |