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

List:       kde-commits
Subject:    kdenonbeta/kdom
From:       Frans Englich <frans.englich () telia ! com>
Date:       2005-11-01 1:18:36
Message-ID: 1130807916.227135.7068.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 476270 by englich:

Some more Doxygen fixes. For the future:

1. When renaming function signatures, don't break the Doxygen. Instead, update the \
Doxygen to reflect the new changes. 2. When documenting a parameter for a function, \
remember to document all the parameters. Either none or all, otherwise Doxygen gets \
picky :/ 3. Someone, please document DOMLookup::DOMLookup()'s "bridge" argument, I \
don't know what it's for.

The Doxygen generated by KDOMBinder for the C++ interfaces is horribly broken, as \
know, probably. The easiest would propably be to pipe the XML out into XSL-T from \
KDOMBinder and then paste the result back it into the header. The XSL-T is \
done(except for line breaking, IIRC), to be found in the previous KDOMBinder. But on \
the other hand, that's the way it previously was solved, which was ditched.



 M  +19 -5     core/DOMImplementationImpl.h  
 M  +2 -2      ecma/DOMLookup.h  
 M  +3 -1      xpointer/kdomxpointer.h  


--- trunk/kdenonbeta/kdom/core/DOMImplementationImpl.h #476269:476270
@@ -55,19 +55,33 @@
         CDFInterface *cdfInterface() const;
 
         // 'DOMImplementationImpl' functions
-        virtual bool hasFeature(DOMStringImpl *feature, DOMStringImpl *version) \
                const; // DOM Level 2
-        virtual DOMObjectImpl *getFeature(DOMStringImpl *feature, DOMStringImpl \
*version) const; // DOM Level 3 +        virtual bool hasFeature(DOMStringImpl \
*feature, +								DOMStringImpl *version) const; // DOM Level 2
+        virtual DOMObjectImpl *getFeature(DOMStringImpl *feature,
+										  DOMStringImpl *version) const; // DOM Level 3
 
-        virtual DocumentTypeImpl *createDocumentType(DOMStringImpl *qualifiedName, \
DOMStringImpl *publicId, DOMStringImpl *systemId) const; +        virtual \
DocumentTypeImpl *createDocumentType(DOMStringImpl *qualifiedName, +													 \
DOMStringImpl *publicId, +													 DOMStringImpl *systemId) const;
 
         /**
+		 * @param namespaceURI The namespace URI of the document element to create or \
null. +		 * @param qualifiedName The qualified name of the document element to be \
created or null. +		 * @param The type of document to be created or null.  When \
doctype is not null, +		 * its Node.ownerDocument attribute is set to the document \
                being created.
          * @param createDocElement this is outside the specification, and is used \
                internally for avoiding
          * creating document elements even if a @p qualifiedName and @p namespaceURI \
                is supplied. If true,
          * it follows the specification, e.g, creates an element if the other \
arguments allows so. +		 * @param view the related KDOMView. Currently not used.
          */
-        virtual DocumentImpl *createDocument(DOMStringImpl *namespaceURI, \
DOMStringImpl *qualifiedName, DocumentTypeImpl *doctype, bool createDocElement = \
true, KDOMView *view = 0) const; +        virtual DocumentImpl \
*createDocument(DOMStringImpl *namespaceURI, +											 DOMStringImpl \
*qualifiedName, +											 DocumentTypeImpl *doctype,
+											 bool createDocElement = true,
+											 KDOMView *view = 0) const;
 
-        virtual CSSStyleSheetImpl *createCSSStyleSheet(DOMStringImpl *title, \
DOMStringImpl *media) const; +        virtual CSSStyleSheetImpl \
*createCSSStyleSheet(DOMStringImpl *title, +													   DOMStringImpl *media) \
const;  
         // Map events to types...
         virtual int typeToId(DOMStringImpl *type);
--- trunk/kdenonbeta/kdom/ecma/DOMLookup.h #476269:476270
@@ -53,13 +53,13 @@
      * @param exec execution state, as usual
      * @param propertyName the property we're looking for
      * @param table the static hashtable for this class
-     * @param thisObj "this"
+     * @param thisObj The implementation object
      */
     template<class FuncImp, class ThisImp>
     inline KJS::Value lookupGet(KJS::ExecState *exec,
                                 const KJS::Identifier &propertyName,
                                 const KJS::HashTable *table,
-                                const ThisImp *thisObj, // the 'impl' object
+                                const ThisImp *thisObj,
                                 const KJS::ObjectImp *bridge)
     {
         const KJS::HashEntry *entry = KJS::Lookup::findEntry(table, propertyName);
--- trunk/kdenonbeta/kdom/xpointer/kdomxpointer.h #476269:476270
@@ -27,7 +27,7 @@
 {
 
 /**
- * @brief An implementation of W3C's <a \
href="http://www.w3.org/TR/xptr-framework/">XPointer</a>.. + * An implementation of \
                W3C's <a href="http://www.w3.org/TR/xptr-framework/">XPointer</a>.
  *
  * @section conformance Conformance
  *
@@ -55,6 +55,8 @@
  *
  * @section reading Related Reading
  *
+ * Related reading, that might be useful:
+ *
  * - <a href="http://xpointerlib.mozdev.org/xpointerGrammar.html">An EBNF 
  *   grammar of the xpointer() scheme</a>
  * - <a href="http://xpointerlib.mozdev.org/">Mozilla's XPointer Lib</a>


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