summaryrefslogtreecommitdiffstats
path: root/Source
diff options
context:
space:
mode:
authorYury G. Kudryashov <urkud.urkud@gmail.com>2012-02-25 09:16:07 (GMT)
committerYury G. Kudryashov <urkud.urkud@gmail.com>2012-02-28 20:17:48 (GMT)
commit54ab11c0d23fcd015ec2e5686524ac9c746ed0ca (patch)
tree845b6db236310c89b2ce69dd0a534963232e9089 /Source
parent80072d4ebfd2bc431649298618e040e1eba5822f (diff)
downloadCMake-54ab11c0d23fcd015ec2e5686524ac9c746ed0ca.zip
CMake-54ab11c0d23fcd015ec2e5686524ac9c746ed0ca.tar.gz
CMake-54ab11c0d23fcd015ec2e5686524ac9c746ed0ca.tar.bz2
doxygen: Improve API docs of GetRealDependency
Use list instead of sequence of sentences in one paragraph.
Diffstat (limited to 'Source')
-rw-r--r--Source/cmLocalGenerator.h21
1 files changed, 12 insertions, 9 deletions
diff --git a/Source/cmLocalGenerator.h b/Source/cmLocalGenerator.h
index 0c5b9d0..c3d057f 100644
--- a/Source/cmLocalGenerator.h
+++ b/Source/cmLocalGenerator.h
@@ -160,15 +160,18 @@ public:
void AppendFeatureOptions(std::string& flags, const char* lang,
const char* feature);
- /** Translate a dependency as given in CMake code to the name to
- appear in a generated build file. If the given name is that of
- a utility target, returns false. If the given name is that of
- a CMake target it will be transformed to the real output
- location of that target for the given configuration. If the
- given name is the full path to a file it will be returned.
- Otherwise the name is treated as a relative path with respect to
- the source directory of this generator. This should only be
- used for dependencies of custom commands. */
+ /** \brief Get absolute path to dependency \a name
+ *
+ * Translate a dependency as given in CMake code to the name to
+ * appear in a generated build file.
+ * - If \a name is a utility target, returns false.
+ * - If \a name is a CMake target, it will be transformed to the real output
+ * location of that target for the given configuration.
+ * - If \a name is the full path to a file, it will be returned.
+ * - Otherwise \a name is treated as a relative path with respect to
+ * the source directory of this generator. This should only be
+ * used for dependencies of custom commands.
+ */
bool GetRealDependency(const char* name, const char* config,
std::string& dep);