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

List:       kde-commits
Subject:    [kdev-ruby] /: Adding some documentation
From:       Miquel_Sabaté <mikisabate () gmail ! com>
Date:       2011-08-10 16:44:29
Message-ID: 20110810164429.39830A60AE () git ! kde ! org
[Download RAW message or body]

Git commit c0249aef172922e7b51f38fff4ab6f3d65694891 by Miquel Sabaté.
Committed on 10/08/2011 at 18:42.
Pushed by mssola into branch 'master'.

Adding some documentation

M  +13   -1    parser/rubyast.h
M  +3    -0    duchain/editorintegrator.h

http://commits.kde.org/kdev-ruby/c0249aef172922e7b51f38fff4ab6f3d65694891

diff --git a/duchain/editorintegrator.h b/duchain/editorintegrator.h
index 0d656e1..0d4b829 100644
--- a/duchain/editorintegrator.h
+++ b/duchain/editorintegrator.h
@@ -87,6 +87,9 @@ public:
     KDevelop::IndexedString url() const;
 
 private:
+    /**
+     * The url of the current document.
+     */
     KDevelop::IndexedString m_url;
 };
 
diff --git a/parser/rubyast.h b/parser/rubyast.h
index 497da10..5e21242 100644
--- a/parser/rubyast.h
+++ b/parser/rubyast.h
@@ -42,10 +42,19 @@ public:
      * @param ctx the KDevelop::DUContext associated with it.
      */
     RubyAst(Node *n, KDevelop::DUContext *ctx = NULL) : tree (n), context(ctx)
-    {};
+    {
+        /* There's nothing to do here! */
+    };
     
 public:
+    /**
+     * The tree of this AST.
+     */
     Node *tree;
+
+    /**
+     * The DUContext for this AST.
+     */
     KDevelop::DUContext *context;
 };
 
@@ -75,6 +84,9 @@ public:
     };
 
 public:
+    /**
+     * The QString that represents this class.
+     */
     QString value;
 };
 

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