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

List:       kde-commits
Subject:    kdelibs/kate/part
From:       Christoph Cullmann <cullmann () kde ! org>
Date:       2005-03-17 17:36:44
Message-ID: 20050317173644.5D0E617B90 () office ! kde ! org
[Download RAW message or body]

CVS commit by cullmann: 

more docs


  M +23 -5     katejscript.h   1.8


--- kdelibs/kate/part/katejscript.h  #1.7:1.8
@@ -98,12 +98,16 @@ class KateJScript
 class KateJScriptManager : public Kate::Command
 {
-  public:
+  private:
+    /**
+     * Internal used Script Representation
+     */
     class Script
     {
       public:
-        QString desktopFilename ()
-        {
-          return filename.left(filename.length()-2).append ("desktop");
-        }
+        /**
+         * get desktop filename
+         * @return desktop filename
+         */
+        inline QString desktopFilename () { return \
filename.left(filename.length()-2).append ("desktop"); }  
       public:
@@ -129,4 +133,8 @@ class KateJScriptManager : public Kate::
 
   private:
+    /**
+     * go, search our scripts
+     * @param force force cache updating?
+     */
     void collectScripts (bool force = false);
 
@@ -144,4 +152,11 @@ class KateJScriptManager : public Kate::
     bool exec( class Kate::View *view, const QString &cmd, QString &errorMsg );
 
+    /**
+     * get help for a command
+     * @param view view to use
+     * @param cmd cmd name
+     * @param msg help message
+     * @return help available or not
+     */
     bool help( class Kate::View *view, const QString &cmd, QString &msg );
 
@@ -153,4 +168,7 @@ class KateJScriptManager : public Kate::
 
   private:
+    /**
+     * we need to know somewhere which scripts are around
+     */
     QDict<KateJScriptManager::Script> m_scripts;
 };


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