From 15878d7f15d8010ecbfca5e239119bd5c44d7f7f Mon Sep 17 00:00:00 2001
From: Niels Weber <niels.weber@theqtcompany.com>
Date: Wed, 24 Feb 2016 11:38:11 +0100
Subject: [PATCH] Minor doc improvement

Change-Id: I4899d4ed34bf1132f688390010640f226ace1264
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
---
 src/plugins/projectexplorer/project.cpp | 12 ++++++++++++
 src/plugins/projectexplorer/project.h   |  1 -
 2 files changed, 12 insertions(+), 1 deletion(-)

diff --git a/src/plugins/projectexplorer/project.cpp b/src/plugins/projectexplorer/project.cpp
index abbe945770f..b9ea25deab1 100644
--- a/src/plugins/projectexplorer/project.cpp
+++ b/src/plugins/projectexplorer/project.cpp
@@ -512,11 +512,23 @@ QVariantMap Project::toMap() const
     return map;
 }
 
+/*!
+    Returns the directory that contains the project.
+
+    This includes the absolute path.
+*/
+
 Utils::FileName Project::projectDirectory() const
 {
     return projectDirectory(projectFilePath());
 }
 
+/*!
+    Returns the directory that contains the file \a top.
+
+    This includes the absolute path.
+*/
+
 Utils::FileName Project::projectDirectory(const Utils::FileName &top)
 {
     if (top.isEmpty())
diff --git a/src/plugins/projectexplorer/project.h b/src/plugins/projectexplorer/project.h
index edcdea2806e..663306137b8 100644
--- a/src/plugins/projectexplorer/project.h
+++ b/src/plugins/projectexplorer/project.h
@@ -76,7 +76,6 @@ public:
 
     Core::IDocument *document() const;
     Utils::FileName projectFilePath() const;
-    // The directory that holds the project. This includes the absolute path.
     Utils::FileName projectDirectory() const;
     static Utils::FileName projectDirectory(const Utils::FileName &top);