[Ktutorial-commits] SF.net SVN: ktutorial:[336] trunk/ktutorial

[<dan...@us...>]

Revision: 336
          http://ktutorial.svn.sourceforge.net/ktutorial/?rev=336&view=rev
Author:   danxuliu
Date:     2011-07-11 13:12:27 +0000 (Mon, 11 Jul 2011)

Log Message:
-----------
Fix doxygen documentation.

Modified Paths:
--------------
    trunk/ktutorial/ktutorial-editor/src/targetapplication/TargetApplication.h
    trunk/ktutorial/ktutorial-editor/src/view/TargetApplicationView.h
    trunk/ktutorial/ktutorial-editor/src/view/TreeModel.h
    trunk/ktutorial/ktutorial-editor/src/view/WaitForWidget.h
    trunk/ktutorial/ktutorial-library/src/KTutorial.h
    trunk/ktutorial/ktutorial-library/src/Step.h
    trunk/ktutorial/ktutorial-library/src/WaitForEvent.h
    trunk/ktutorial/ktutorial-library/src/scripting/ScriptingModule.h

Modified: trunk/ktutorial/ktutorial-editor/src/targetapplication/TargetApplication.h
===================================================================
--- trunk/ktutorial/ktutorial-editor/src/targetapplication/TargetApplication.h	2011-07-11 05:25:48 UTC (rev 335)
+++ trunk/ktutorial/ktutorial-editor/src/targetapplication/TargetApplication.h	2011-07-11 13:12:27 UTC (rev 336)
@@ -113,7 +113,7 @@
      * an empty string. If the path is absolute but contains "." and ".."
      * components they are resolved and the clean path is set.
      *
-     * @param applicationFilePath The target application file path.
+     * @param targetApplicationFilePath The target application file path.
      */
     void setTargetApplicationFilePath(const QString& targetApplicationFilePath);
 

Modified: trunk/ktutorial/ktutorial-editor/src/view/TargetApplicationView.h
===================================================================
--- trunk/ktutorial/ktutorial-editor/src/view/TargetApplicationView.h	2011-07-11 05:25:48 UTC (rev 335)
+++ trunk/ktutorial/ktutorial-editor/src/view/TargetApplicationView.h	2011-07-11 13:12:27 UTC (rev 336)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2010 by Daniel Calviño Sánchez                          *
+ *   Copyright (C) 2010-2011 by Daniel Calviño Sánchez                     *
  *   dan...@gm...                                                    *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
@@ -35,7 +35,7 @@
     /**
      * Creates a new TargetApplicationView for the given TargetApplication.
      *
-     * @param step The step to edit.
+     * @param targetApplication The target application to wrap.
      * @param parent The parent QWidget for the dialogs and message boxes.
      */
     explicit TargetApplicationView(TargetApplication* targetApplication,

Modified: trunk/ktutorial/ktutorial-editor/src/view/TreeModel.h
===================================================================
--- trunk/ktutorial/ktutorial-editor/src/view/TreeModel.h	2011-07-11 05:25:48 UTC (rev 335)
+++ trunk/ktutorial/ktutorial-editor/src/view/TreeModel.h	2011-07-11 13:12:27 UTC (rev 336)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2010 by Daniel Calviño Sánchez                          *
+ *   Copyright (C) 2010-2011 by Daniel Calviño Sánchez                     *
  *   dan...@gm...                                                    *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
@@ -80,6 +80,7 @@
      * If the index is valid, the flags enable the item and allow it to be
      * selected.
      *
+     * @param index The index.
      * @return The flags for the given index.
      */
     virtual Qt::ItemFlags flags(const QModelIndex& index) const;

Modified: trunk/ktutorial/ktutorial-editor/src/view/WaitForWidget.h
===================================================================
--- trunk/ktutorial/ktutorial-editor/src/view/WaitForWidget.h	2011-07-11 05:25:48 UTC (rev 335)
+++ trunk/ktutorial/ktutorial-editor/src/view/WaitForWidget.h	2011-07-11 13:12:27 UTC (rev 336)
@@ -53,6 +53,7 @@
     /**
      * Creates a new WaitForWidget.
      *
+     * @param waitFor The initial WaitFor.
      * @param parent The parent QWidget.
      */
     explicit WaitForWidget(WaitFor* waitFor, QWidget* parent = 0);

Modified: trunk/ktutorial/ktutorial-library/src/KTutorial.h
===================================================================
--- trunk/ktutorial/ktutorial-library/src/KTutorial.h	2011-07-11 05:25:48 UTC (rev 335)
+++ trunk/ktutorial/ktutorial-library/src/KTutorial.h	2011-07-11 13:12:27 UTC (rev 336)
@@ -74,7 +74,7 @@
      * Any WaitFor class has to be registered before calling
      * setup(KXmlGuiWindow*).
      *
-     * @param scriptedWaitFor The QMetaObject to create instances of.
+     * @param waitForMetaObject The QMetaObject to create instances of.
      * @param typeName A specific name to be used for the QMetaObject.
      * @return True if the type was successfully registered, false otherwise.
      * @see ScriptingModule::registerWaitForMetaObject(const QMetaObject&)

Modified: trunk/ktutorial/ktutorial-library/src/Step.h
===================================================================
--- trunk/ktutorial/ktutorial-library/src/Step.h	2011-07-11 05:25:48 UTC (rev 335)
+++ trunk/ktutorial/ktutorial-library/src/Step.h	2011-07-11 13:12:27 UTC (rev 336)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2008-2010 by Daniel Calviño Sánchez                     *
+ *   Copyright (C) 2008-2011 by Daniel Calviño Sánchez                     *
  *   dan...@gm...                                                    *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
@@ -241,7 +241,7 @@
      * This method can be invoked from a script.
      *
      * @param option The Option to add.
-     * @param nextStep The id of the step to change to.
+     * @param nextStepId The id of the step to change to.
      * @see addOption(Option*, QObject*, const QString&)
      */
     Q_INVOKABLE void addOption(Option* option, const QString& nextStepId);
@@ -286,7 +286,7 @@
      * This method can be invoked from a script.
      *
      * @param waitFor The condition to wait for.
-     * @param nextStep The id of the step to change to.
+     * @param nextStepId The id of the step to change to.
      * @see addOption(Option*, QObject*, const QString&)
      */
     Q_INVOKABLE void addWaitFor(WaitFor* waitFor, const QString& nextStepId);

Modified: trunk/ktutorial/ktutorial-library/src/WaitForEvent.h
===================================================================
--- trunk/ktutorial/ktutorial-library/src/WaitForEvent.h	2011-07-11 05:25:48 UTC (rev 335)
+++ trunk/ktutorial/ktutorial-library/src/WaitForEvent.h	2011-07-11 13:12:27 UTC (rev 336)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2010 by Daniel Calviño Sánchez                          *
+ *   Copyright (C) 2010-2011 by Daniel Calviño Sánchez                     *
  *   dan...@gm...                                                    *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
@@ -66,7 +66,7 @@
      * Creates a new WaitForEvent.
      *
      * @param object The object to watch.
-     * @param typeName The name of the event type to wait for.
+     * @param type The type of the event to wait for.
      */
     WaitForEvent(QObject* object, QEvent::Type type);
 

Modified: trunk/ktutorial/ktutorial-library/src/scripting/ScriptingModule.h
===================================================================
--- trunk/ktutorial/ktutorial-library/src/scripting/ScriptingModule.h	2011-07-11 05:25:48 UTC (rev 335)
+++ trunk/ktutorial/ktutorial-library/src/scripting/ScriptingModule.h	2011-07-11 13:12:27 UTC (rev 336)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2009 by Daniel Calviño Sánchez                          *
+ *   Copyright (C) 2009-2011 by Daniel Calviño Sánchez                     *
  *   dan...@gm...                                                    *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
@@ -87,7 +87,7 @@
      * with that name). However, if no name is specified, the full name of the
      * class is used (including namespaces and :: separators).
      *
-     * @param scriptedWaitFor The QMetaObject to create instances of.
+     * @param waitForMetaObject The QMetaObject to create instances of.
      * @param typeName A specific name to be used for the QMetaObject.
      * @return True if the type was successfully registered, false otherwise.
      */


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.