*api: document all modules in modules.idl

Change-Id: I1c0c89f515f06bd14b659836d777aa705a6f03d6

1 files changed, 280 insertions, 67 deletions

diff --git a/offapi/com/sun/star/modules.idl b/offapi/com/sun/star/modules.idl
index a379e80150a3..d7bf65de4540 100644
--- a/offapi/com/sun/star/modules.idl
+++ b/offapi/com/sun/star/modules.idl
@@ -19,13 +19,12 @@
 #ifndef __com_sun_star_modules_idl__
 #define __com_sun_star_modules_idl__
 
-module com { module sun { module star {
-
-/// security and authenticates interfaces
-module auth {};
+/* note: this file contains documentation of the modules.
+         sub-modules of modules are documented here too so there aren't
+         lots of tiny documentation only files everywhere.
+*/
 
-/// Java AWT-like user interface toolkit interface specifications for UNO.
-module awt {};
+module com { module sun { module star {
 
 /** UNO Accessibility API
 
@@ -57,6 +56,26 @@ module awt {};
 */
 module accessibility {};
 
+/// interfaces for SMIL animations.
+module animations {};
+
+/// security and authenticates interfaces
+module auth {};
+
+/// Java AWT-like user interface toolkit interface specifications for UNO.
+module awt {
+
+    /// grid control.
+    module grid {};
+
+    /// tab pages.
+    module tab {};
+
+    /// hierarchical (tree) control.
+    module tree {};
+
+};
+
 /// Charting diagram interfaces.
 module chart {};
 
@@ -64,31 +83,104 @@ module chart {};
     contains only a rather small public API.  In addition there is a
     private API in the chart2 project.
  */
-module chart2 {};
+module chart2 {
+
+    /// Chart data provider interfaces.
+    module data {};
+};
 
 /// Access to the tree of configuration data.
-module configuration {};
+module configuration {
+
+    /// interfaces for configuration backends.
+    module backend {
+        /// XML files backend.
+        module xml {};
+    };
+
+    /// deprecated bootstrapping mechanism.
+    module bootstrap {};
+
+};
+
+/// TODO: what is this?
+module cui {};
 
 /// Clipboard and Drag&Drop interfaces.
-module datatransfer {};
+module datatransfer {
+
+    /// Clipboard specific interfaces.
+    module clipboard {};
+
+    /// Drag&Drop specific interfaces.
+    module dnd {};
+
+};
+
+/// interfaces for extension management.
+module deployment {
+
+    // this looks like it should not be documented
+    module test {};
+
+    /// interfaces for extension management dialogs.
+    module ui {};
+
+};
 
 /// Office document related interfaces.
 module document {};
 
-/// Office document content related interfaces.
-module office {};
-
 /// Drawing and shape specific interfaces.
-module drawing {};
+module drawing {
+
+    /// Draw/Impress user interface framework.
+    module framework {};
+
+};
+
+/// interfaces related to embedded objects, both native UNO and OLE.
+module embed {};
 
 /// Interfaces for managing forms and controls.
-module form {};
+module form {
+
+    /// form bindings.
+    module binding {};
+
+    /// form components (model part of the controls).
+    module component {};
+
+    /// form components (view part of the controls).
+    module control {};
+
+    /// various property handlers for forms.
+    module inspection {};
+
+    /// core components of forms.
+    module runtime {};
+
+    /// for submission of data from forms.
+    module submission {};
+
+    /// for validation of form data.
+    module validation {};
+
+};
 
 /// Interfaces for mathematical formulas.
 module formula {};
 
 /// Desktop environment framework interfaces.
-module frame {};
+module frame {
+
+    /// various status properties.
+    module status {};
+
+};
+
+/// interfaces for galleries of images and media objects.
+module gallery {};
 
 /// Interfaces and data types to deal with basic geometric entities
 module geometry {};
@@ -100,12 +192,21 @@ module graphic {};
     subject to change. */
 module i18n {};
 
+/// interfaces for HTML image maps.
+module image {};
+
+/// interfaces for inspecting UNO objects via property handlers.
+module inspection {};
+
 /// lightweight directory access protocol (LDAP)
 module ldap {};
 
 /// Spell checker, hyphenation and thesaurus interfaces.
 module linguistic2 {};
 
+/// logging of events.
+module logging {};
+
 /// Interfaces for Email connectivity
 module mail {};
 
@@ -115,26 +216,118 @@ module media {};
 /// Interfaces for Mozilla integration.
 module mozilla {};
 
+/// Office document content related interfaces.
+module office {};
+
+/// Package file format interfaces.
+module packages {
+
+    /// interfaces for reading and writing manifest.xml files in ODF packages.
+    module manifest {};
+
+    /// for direct access to ZIP packages.
+    module zip {};
+
+};
+
 /// Netscape-like plugin interfaces.
 module plugin {};
 
 /// Presentation specific interfaces.
-module presentation {};
+module presentation {
+
+    /// for text fields in presentation documents.
+    module textfield {};
+
+};
+
+/// Interfaces for QA and automated tests
+module qa {};
+
+/** RDF (Resource Description Framework) and metadata interfaces.
+
+    <p>
+    This module provides interfaces for storing and accessing metadata
+    in <a href="http://www.w3.org/RDF/">Resource Description Framework</a>
+    format.
+    The API consists of two main parts: the RDF data model and the ODF
+    document integration.
+    </p>
+
+    <p>
+    The <a href="http://www.w3.org/TR/rdf-concepts/">RDF data model</a>
+    describes graphs of statements.
+    The nodes in the graph are of type rdf::XNode,
+    which has several subtypes: rdf::XResource,
+    rdf::XBlankNode,
+    rdf::XURI and rdf::XLiteral.
+    Statements are then triples of nodes, and have type
+    rdf::Statement.
+    </p>
+
+    <p>
+    The main part of the RDF data model is the
+    rdf::XRepository, which consists of a set of graphs.
+    The repository allows for importing/exporting graphs from/to files,
+    as well as querying the contents of the repository.
+    The type of the graphs is rdf::XNamedGraph.
+    </p>
+
+    <p>
+    Documents that support metadata implement the interfaces
+    rdf::XRepositorySupplier and
+    rdf::XDocumentMetadataAccess.
+    Furthermore, all elements of ODF documents that may have metadata attached
+    implement the interface rdf::XMetadatable.
+    </p>
+
+ */
+module rdf {};
 
 /// Interfaces and data structures for rendering
 module rendering {};
 
+/// interfaces for reports generated from data sources.
+module report {
+
+    /// property handlers for reports.
+    module inspection {};
+
+    /// report meta data.
+    module meta {};
+
+};
+
 /// Interfaces to access (UI) resource files.
 module resource {};
 
-/// Interfaces for QA and automated tests
-module qa {};
-
 /// Interfaces for scanner control.
 module scanner {};
 
+/// Scripting language bindings.
+module script {
+
+    /// manage available scripts in some sort of hierarchy.
+    module browse {};
+
+    /// interfaces for scripting providers.
+    module provider {};
+
+    /// VBA scripting.
+    module vba {};
+
+};
+
 /// Basic interfaces for database access.
-module sdb {};
+module sdb {
+
+    /// application UI.
+    module application {};
+
+    /// misc stuff.
+    module tools {};
+
+};
 
 /// Database component interfaces.
 module sdbc {};
@@ -142,15 +335,27 @@ module sdbc {};
 /// High-level database component interfaces.
 module sdbcx {};
 
+/// cryptographic interfaces.
+module security {};
+
+/// TODO: what is this?
+module setup {};
+
 /// Spreadsheet specific interfaces.
 module sheet {};
 
+/// allows to put smart tags in document content.
+module smarttags {};
+
 /// Formatting and layout style and style sheet interfaces.
 module style {};
 
 /// Interfaces for import/export of Scaleable Vector Format.
 module svg {};
 
+/// Host operating system integration interfaces.
+module system {};
+
 /// Table specific interfaces (for text and spreadsheet).
 module table {};
 
@@ -158,13 +363,31 @@ module table {};
 module task {};
 
 /// Text specific interfaces.
-module text {};
+module text {
+
+    /// text field masters.
+    module fieldmaster {};
+
+    /// text fields.
+    module textfield {
+
+        /// Document Properties text fields.
+        module docinfo {};
+
+    };
+
+};
 
 /// Universal Content Broker interfaces.
 module ucb {};
 
 /// Dialogs and other UI elements.
-module ui {};
+module ui {
+
+    /// dialogs.
+    module dialogs {};
+
+};
 
 /// Miscellaneous interfaces for sorting, connecting objects etc.
 module util {};
@@ -172,63 +395,53 @@ module util {};
 /// Document view specific interfaces (e.g. selection access and printing).
 module view {};
 
+/// interfaces for XForms (XML-based forms) implementation
+module xforms {};
+
 /// XML related interfaces.
-module xml {};
+module xml {
 
-/// Host operating system integration interfaces.
-module system {};
+    /// XML encryption interfaces.
+    module crypto {
 
-/// Package file format interfaces.
-module packages {};
+        /// XML encryption SAX interfaces.
+        module sax {};
 
-/// image manipulation interfaces.
-module image {};
+    };
 
-/// interfaces for XForms (XML-based forms) implementation
-module xforms {};
+    /// Compressed SAX interfaces.
+    module csax {};
 
-/// interfaces for report interfaces
-module report {};
+    /// XML Document Object Model.
+    module dom {
 
-/** RDF (Resource Description Framework) and metadata interfaces.
+        /// XML Document Object Model events.
+        module events {};
 
-    <p>
-    This module provides interfaces for storing and accessing metadata
-    in <a href="http://www.w3.org/RDF/">Resource Description Framework</a>
-    format.
-    The API consists of two main parts: the RDF data model and the ODF
-    document integration.
-    </p>
+        /// XML Document Object Model views.
+        module views {};
 
-    <p>
-    The <a href="http://www.w3.org/TR/rdf-concepts/">RDF data model</a>
-    describes graphs of statements.
-    The nodes in the graph are of type rdf::XNode,
-    which has several subtypes: rdf::XResource,
-    rdf::XBlankNode,
-    rdf::XURI and rdf::XLiteral.
-    Statements are then triples of nodes, and have type
-    rdf::Statement.
-    </p>
+    };
 
-    <p>
-    The main part of the RDF data model is the
-    rdf::XRepository, which consists of a set of graphs.
-    The repository allows for importing/exporting graphs from/to files,
-    as well as querying the contents of the repository.
-    The type of the graphs is rdf::XNamedGraph.
-    </p>
+    /// no idea what this does but it's all marked "internal".
+    module input {};
 
-    <p>
-    Documents that support metadata implement the interfaces
-    rdf::XRepositorySupplier and
-    rdf::XDocumentMetadataAccess.
-    Furthermore, all elements of ODF documents that may have metadata attached
-    implement the interface rdf::XMetadatable.
-    </p>
+    /// SAX interfaces.
+    module sax {};
 
- */
-module rdf {};
+    /// something related to creating DOMs from SAX interfaces?
+    module wrapper {};
+
+    /// XPath interfaces.
+    module xpath {};
+
+    /// XSLT interfaces.
+    module xslt {};
+
+};
+
+/// W3C XML Schema-2 data type related interfaces.
+module xsd {};
 
 }; }; };