core: (fixes #715) Clarify that Version::VersionTag() is used exclusively for ns-3 prefixed tags

Gabrielcarvfer · Gabrielcarvfer · commit 4dc81b54b917 · 2025-06-10T11:50:56.000+02:00
diff --git a/src/core/model/version.h b/src/core/model/version.h
@@ -91,7 +91,7 @@ class Version
 {
   public:
     /**
-     * Returns the ns-3 version tag of the closest ancestor commit.
+     * Returns the ns-3 version tag of the closest ancestor commit prefixed with ns-3.
      *
      * The format of the tag is
      * @verbatim ns3-<major>.<minor>[.patch] \endverbatim

Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ class Version`
`91`	`91`	`{`
`92`	`92`	`public:`
`93`	`93`	`/**`
`94`		`- * Returns the ns-3 version tag of the closest ancestor commit.`
	`94`	`+ * Returns the ns-3 version tag of the closest ancestor commit prefixed with ns-3.`
`95`	`95`	`*`
`96`	`96`	`* The format of the tag is`
`97`	`97`	`* @verbatim ns3-<major>.<minor>[.patch] \endverbatim`