[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    kdevelop/parts/documentation/interfaces
From:       Alexander Dymo <cloudtemple () mksat ! net>
Date:       2004-12-08 22:47:47
Message-ID: 20041208224747.DDF931BBFA () office ! kde ! org
[Download RAW message or body]

CVS commit by dymo: 

API documentation improvements, updates and fixes for documentation part interfaces.


  A            Mainpage.dox   1.1
  M +5 -0      Makefile.am   1.2
  M +16 -1     kdevdocumentationplugin.h   1.14


--- kdevelop/parts/documentation/interfaces/Makefile.am  #1.1:1.2
@@ -9,2 +9,7 @@
 servicetypedir = $(kde_servicetypesdir)
 servicetype_DATA = kdevelopdocumentationplugins.desktop
+
+DOXYGEN_REFERENCES = dcop interfaces kdecore kdefx kdeui khtml kmdi kio kjs kparts \
kutils kdevutil kdevinterfaces +DOXYGEN_PROJECTNAME = KDevelop Documentation Part \
Interfaces Library +DOXYGEN_DOCDIRPREFIX = kdevdoc
+include ../../../Doxyfile.am

--- kdevelop/parts/documentation/interfaces/kdevdocumentationplugin.h  #1.13:1.14
@@ -31,8 +31,16 @@
 #define CACHE_VERSION "3"
 
+/**Documentation list item.
+Stores the type of a documentation it represents and an URL.*/
 class DocumentationItem: public KListViewItem
 {
 public:
-    enum Type { Collection, Catalog, Book, Document };
+    /**Type of documentation which is represented by this item.*/
+    enum Type {
+        Collection    /**<Collection - a collection of catalogs, folder with \
catalogs.*/, +        Catalog       /**<Catalog - a term which defines a document or \
a group of documents.*/,  +        Book          /**<Book - a document with nested \
documents.*/,  +        Document      /**<Document.*/
+    };
 
     DocumentationItem(Type type, KListView *parent, const QString &name);
@@ -55,4 +63,5 @@ private:
 class DocumentationPlugin;
 
+/**Documentation catalog list item.*/
 class DocumentationCatalogItem: public DocumentationItem
 {
@@ -82,4 +91,6 @@ private:
 class IndexBox;
 
+/**Prototype of index item.
+Prototypes represent an index are used to build index items after index \
generation.*/  class IndexItemProto
 {
@@ -101,4 +112,5 @@ private:
 };
 
+/**Documentation index item.*/
 class IndexItem: public QListBoxText {
 public:
@@ -114,4 +126,5 @@ private:
 };
 
+/**Documentation index view.*/
 class IndexBox: public KListBox{
 public:
@@ -136,4 +149,5 @@ class QColorGroup;
 class QFontMetrics;
 
+/**Documentation configuration item.*/
 class ConfigurationItem: public QCheckListItem
 {
@@ -254,4 +268,5 @@ public:
     IndexItem objects.
     @param index the listbox which contains index items
+    @param item the catalog item that holds an index being built
     */
     virtual void createIndex(IndexBox *index, DocumentationCatalogItem *item) = 0;


[prev in list] [next in list] [prev in thread] [next in thread]