Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix various DDOC warnings #2558

Merged
merged 1 commit into from
Jan 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion source/dub/dependency.d
Original file line number Diff line number Diff line change
Expand Up @@ -872,7 +872,7 @@ struct Version {
* $(LI `"^1.0.0"` - semver compatible version range (same version if 0.x.y, ==major >=minor.patch if x.y.z))
* $(LI `"^1.0"` - same as ^1.0.0)
* $(LI `"~master"` - a branch name)
* $(LI `"*" - match any version (see also `VersionRange.Any`))
* $(LI `"*"` - match any version (see also `VersionRange.Any`))
* )
*
* Apart from "$(LT)" and "$(GT)", "$(GT)=" and "$(LT)=" are also valid
Expand Down
9 changes: 5 additions & 4 deletions source/dub/dub.d
Original file line number Diff line number Diff line change
Expand Up @@ -934,7 +934,7 @@ class Dub {

Params:
package_id = Name of the package to be removed
location_ = Specifies the location to look for the given package
location = Specifies the location to look for the given package
name/version.
resolve_version = Callback to select package version.
*/
Expand Down Expand Up @@ -998,7 +998,7 @@ class Dub {
is passed, the package will be removed from the location, if
there is only one version retrieved. This will throw an
exception, if there are multiple versions retrieved.
location_ = Specifies the location to look for the given package
location = Specifies the location to look for the given package
name/version.
*/
void remove(string package_id, string version_, PlacementLocation location)
Expand Down Expand Up @@ -1144,8 +1144,8 @@ class Dub {
preferring "~master".

Params:
package_name: The name of the package in question.
prefer_stable: If set to `true` (the default), returns the latest
package_name = The name of the package in question.
prefer_stable = If set to `true` (the default), returns the latest
stable version, even if there are newer pre-release versions.

See_also: `listPackageVersions`
Expand All @@ -1169,6 +1169,7 @@ class Dub {
format = Determines the package recipe format to use.
recipe_callback = Optional callback that can be used to
customize the recipe before it gets written.
app_args = Arguments to provide to the custom initialization routine.
*/
void createEmptyPackage(NativePath path, string[] deps, string type,
PackageFormat format = PackageFormat.sdl,
Expand Down
1 change: 1 addition & 0 deletions source/dub/init.d
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ import std.string;
version.
type = The type of package skeleton to create. Can currently be
"minimal", "vibe.d" or "deimos"
format = Format in which the recipe will be written (SDL / JSON)
recipe_callback = Optional callback that can be used to customize the
package recipe and the file format used to store it prior to
writing it to disk.
Expand Down
23 changes: 12 additions & 11 deletions source/dub/internal/logging.d
Original file line number Diff line number Diff line change
Expand Up @@ -199,8 +199,8 @@ void setLoggingColorsEnabled(bool enabled)
or tag color required (since there will be no tag).

Params:
level = The log level for the logged message
fmt = See http://dlang.org/phobos/std_format.html#format-string
args = Arguments matching the format string
*/
void logDebug(T...)(string fmt, lazy T args) nothrow
{
Expand All @@ -220,8 +220,8 @@ void logDiagnostic(T...)(string fmt, lazy T args) nothrow
Params:
tag = The string the tag at the beginning of the line should contain
tagColor = The color the tag string should have
level = The log level for the logged message
fmt = See http://dlang.org/phobos/std_format.html#format-string
args = Arguments matching the format string
*/
void logInfo(T...)(string tag, Color tagColor, string fmt, lazy T args) nothrow
{
Expand All @@ -234,8 +234,8 @@ void logInfo(T...)(string tag, Color tagColor, string fmt, lazy T args) nothrow
case there will be an identation of tagWidth chars on the left anyway).

Params:
level = The log level for the logged message
fmt = See http://dlang.org/phobos/std_format.html#format-string
args = Arguments matching the format string
*/
void logInfo(T...)(string fmt, lazy T args) nothrow if (!is(T[0] : Color))
{
Expand All @@ -247,8 +247,8 @@ void logInfo(T...)(string fmt, lazy T args) nothrow if (!is(T[0] : Color))
print a tag at all, it effectively just prints the given string.

Params:
level = The log level for the logged message
fmt = See http://dlang.org/phobos/std_format.html#format-string
args = Arguments matching the format string
*/
void logInfoNoTag(T...)(string fmt, lazy T args) nothrow if (!is(T[0] : Color))
{
Expand All @@ -261,8 +261,8 @@ void logInfoNoTag(T...)(string fmt, lazy T args) nothrow if (!is(T[0] : Color))

Params:
tag = The string the tag at the beginning of the line should contain
level = The log level for the logged message
fmt = See http://dlang.org/phobos/std_format.html#format-string
args = Arguments matching the format string
*/
void logWarnTag(T...)(string tag, string fmt, lazy T args) nothrow
{
Expand All @@ -274,8 +274,8 @@ void logWarnTag(T...)(string tag, string fmt, lazy T args) nothrow
tag "Warning". The tag color is also fixed to yellow.

Params:
level = The log level for the logged message
fmt = See http://dlang.org/phobos/std_format.html#format-string
args = Arguments matching the format string
*/
void logWarn(T...)(string fmt, lazy T args) nothrow
{
Expand All @@ -288,8 +288,8 @@ void logWarn(T...)(string fmt, lazy T args) nothrow

Params:
tag = The string the tag at the beginning of the line should contain
level = The log level for the logged message
fmt = See http://dlang.org/phobos/std_format.html#format-string
args = Arguments matching the format string
*/
void logErrorTag(T...)(string tag, string fmt, lazy T args) nothrow
{
Expand All @@ -301,8 +301,8 @@ void logErrorTag(T...)(string tag, string fmt, lazy T args) nothrow
tag "Error". The tag color is also fixed to red.

Params:
level = The log level for the logged message
fmt = See http://dlang.org/phobos/std_format.html#format-string
args = Arguments matching the format string
*/
void logError(T...)(string fmt, lazy T args) nothrow
{
Expand All @@ -322,6 +322,7 @@ void logError(T...)(string fmt, lazy T args) nothrow
tag = The string the tag at the beginning of the line should contain
tagColor = The color the tag string should have
fmt = See http://dlang.org/phobos/std_format.html#format-string
args = Arguments matching the format string
*/
void log(T...)(
LogLevel level,
Expand Down Expand Up @@ -382,8 +383,8 @@ void log(T...)(

Params:
str = The string to color
color = The color to apply
mode = An optional mode, such as bold/underline/etc...
c = The color to apply
m = An optional mode, such as bold/underline/etc...
*/
string color(const string str, const Color c, const Mode m = Mode.init)
{
Expand All @@ -402,7 +403,7 @@ string color(const string str, const Color c, const Mode m = Mode.init)

Params:
str = The string to color
mode = The mode, such as bold/underline/etc...
m = The mode, such as bold/underline/etc...
*/
string color(const string str, const Mode m = Mode.init)
{
Expand Down
1 change: 1 addition & 0 deletions source/dub/internal/vibecompat/data/json.d
Original file line number Diff line number Diff line change
Expand Up @@ -1731,6 +1731,7 @@ struct JsonStringSerializer(R, bool pretty = false)
Params:
dst = References the string output range to which the result is written.
json = Specifies the JSON value that is to be stringified.
level = The nesting level at which to write the JSON object (for pretty output).

See_Also: Json.toString, writePrettyJsonString
*/
Expand Down
2 changes: 1 addition & 1 deletion source/dub/project.d
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,7 @@ class Project {
/** Adds a test runner configuration for the root package.

Params:
settings = The generator settings to use
generate_main = Whether to generate the main.d file
base_config = Optional base configuration
custom_main_file = Optional path to file with custom main entry point
Expand Down Expand Up @@ -822,7 +823,6 @@ class Project {
Params:
dst = The `BuildSettings` instance to add the build settings to
gsettings = Target generator settings
build_type = Name of the build type
for_root_package = Selects if the build settings are for the root
package or for one of the dependencies. Unittest flags will
only be added to the root package.
Expand Down