Format documentation of IVersionControl so that Doxygen recognizes it

src/plugins/coreplugin/iversioncontrol.h

@@ -48,46 +48,66 @@ public:
 
     virtual QString name() const = 0;
 
-    // Enable the VCS, that is, make its menu actions visible.
     virtual bool isEnabled() const = 0;
+
+    /*!
+     * Enable the VCS, that is, make its menu actions visible.
+     */
     virtual void setEnabled(bool enabled) = 0;
 
-    // Returns whether files in this directory should be managed with this
+    /*!
-    // version control.
+     * Returns whether files in this directory should be managed with this
+     * version control.
+     */
     virtual bool managesDirectory(const QString &filename) const = 0;
 
-    // This function should return the topmost directory, for which this
+    /*!
-    // IVersionControl should be used. The VCSManager assumes that all files
+     * This function should return the topmost directory, for which this
-    // in the returned directory are managed by the same IVersionControl
+     * IVersionControl should be used. The VCSManager assumes that all files in
-    // Note that this is used as an optimization, so that the VCSManager
+     * the returned directory are managed by the same IVersionControl.
-    // doesn't need to call managesDirectory(..) for each directory
+     *
-    // This function is called after finding out that the directory is managed
+     * Note that this is used as an optimization, so that the VCSManager
-    // by a specific version control.
+     * doesn't need to call managesDirectory(..) for each directory.
+     *
+     * This function is called after finding out that the directory is managed
+     * by a specific version control.
+     */
     virtual QString findTopLevelForDirectory(const QString &directory) const = 0;
 
-    // Called to query whether a VCS supports the respective operations.
+    /*!
+     * Called to query whether a VCS supports the respective operations.
+     */
     virtual bool supportsOperation(Operation operation) const = 0;
 
-    // Called prior to save, if the file is read only. Should be implemented
+    /*!
-    // if the scc requires a operation before editing the file, e.g. 'p4 edit'
+     * Called prior to save, if the file is read only. Should be implemented if
-    // Note: The EditorManager calls this for the editors.
+     * the scc requires a operation before editing the file, e.g. 'p4 edit'
+     *
+     * \note The EditorManager calls this for the editors.
+     */
     virtual bool vcsOpen(const QString &fileName) = 0;
 
-    // Called after a file has been added to a project If the version control
+    /*!
-    // needs to know which files it needs to track you should reimplement this
+     * Called after a file has been added to a project If the version control
-    // function, e.g. 'p4 add', 'cvs add', 'svn add'.
+     * needs to know which files it needs to track you should reimplement this
-    // Note: This function should be called from IProject subclasses after
+     * function, e.g. 'p4 add', 'cvs add', 'svn add'.
-    // files are added to the project
+     *
+     * \note This function should be called from IProject subclasses after
+     *       files are added to the project.
+     */
     virtual bool vcsAdd(const QString &filename) = 0;
 
-    // Called after a file has been removed from the project (if the user
+    /*!
-    // wants), e.g. 'p4 delete', 'svn delete'.
+     * Called after a file has been removed from the project (if the user
-    // You probably want to call VcsManager::showDeleteDialog, which asks the
+     * wants), e.g. 'p4 delete', 'svn delete'.
-    // user to confirm the deletion
+     *
+     * You probably want to call VcsManager::showDeleteDialog, which asks the
+     * user to confirm the deletion.
+     */
     virtual bool vcsDelete(const QString &filename) = 0;
 
     // TODO: ADD A WAY TO DETECT WHETHER A FILE IS MANAGED, e.g
-    // virtual bool sccManaged(const QStryng &filename) = 0;
+    // virtual bool sccManaged(const QString &filename) = 0;
 };
 
 } // namespace Core