From a6c23262063826e29dee7dcaca408204e76db888 Mon Sep 17 00:00:00 2001 From: WebFreak001 Date: Sun, 12 Feb 2023 20:58:09 +0100 Subject: [PATCH] improve docs --- source/dub/recipe/packagerecipe.d | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/source/dub/recipe/packagerecipe.d b/source/dub/recipe/packagerecipe.d index d2822332c4..ce406bcfec 100644 --- a/source/dub/recipe/packagerecipe.d +++ b/source/dub/recipe/packagerecipe.d @@ -38,7 +38,8 @@ string[] getSubPackagePath(string package_name) @safe pure } /** - Returns the name of the top level package for a given (sub) package name. + Returns the name of the top level package for a given (sub) package name of + format `"basePackageName"` or `"basePackageName:subPackageName"`. In case of a top level package, the qualified name is returned unmodified. */ @@ -48,7 +49,8 @@ string getBasePackageName(string package_name) @safe pure } /** - Returns the qualified sub package part of the given package name. + Returns the qualified sub package part of the given package name of format + `"basePackageName:subPackageName"`, or empty string if none. This is the part of the package name excluding the base package name. See also $(D getBasePackageName).