docs: Fix building docs, and update ddox.

Author: Abscissa

CHANGELOG.md

@@ -23,6 +23,7 @@ Update from `vibe-d:core` to `vibe-core`, and various other improvements.
 - **Tests:** Fixed: USE_UNIT_THREADED envar doen't actually use unit-threaded.
 - **Tests:** Better diagnostics when using alternate `dub.selections.json`. (@SingingBush)
 - **Docs:** Add documentation and CI-related policies to `.travis.yml`.
+- **Docs:** Update modified ddox from 0.16.6 to 0.16.12.
 - **Internal:** [#212](https://github.com/mysql-d/mysql-native/issues/212):
     Add [.editorconfig](https://editorconfig.org/) file. (@schveiguy)
 

build-docs

@@ -1,4 +1,13 @@
 #!/bin/sh
+
+# Please use DMD 2.077.1 or below when building the documentation.
+#
+# DMD 2.078.0 and up causes lots of duplicated symbols in the documentation.
+# (See: https://github.com/rejectedsoftware/ddox/issues/208 )
+#
+# DMD 2.086.0 and up cause errors when building the docs because
+# gen-package-version and Scriptlike need updated.
+
 rdmd --build-only -c -Isource -Dddocs_tmp -X -Xfdocs/docs.json -version=MySQLDocs --force source/mysql/package.d
 rm -rf docs_tmp
 rm source/mysql/package.o

build-docs.bat

@@ -1,4 +1,13 @@
 @echo off
+
+rem  Please use DMD 2.077.1 or below when building the documentation.
+rem
+rem  DMD 2.078.0 and up causes lots of duplicated symbols in the documentation.
+rem  (See: https://github.com/rejectedsoftware/ddox/issues/208 )
+rem
+rem  DMD 2.086.0 and up cause errors when building the docs because
+rem  gen-package-version and Scriptlike need updated.
+
 rdmd --build-only -c -Isource -Dddocs_tmp -X -Xfdocs/docs.json -version=MySQLDocs --force source/mysql/package.d
 rmdir /S /Q docs_tmp > NUL 2> NUL
 del source\mysql\package.obj

ddox/.gitignore

@@ -2,6 +2,7 @@
 /ddox
 /__*
 node_modules
+ddox-test-library
 test/screenshots/*.diff.png
 test/screenshots/*.fail.png
 tests/*/test.json

ddox/.travis.yml

@@ -1,12 +1,9 @@
 language: d
-services:
-  - docker
+d: dmd-2.078.1
 addons:
   apt:
     packages:
     - libevent-dev
     - libssl-dev
-    - pkg-config
-    - zlib1g-dev
 
 script: ./travis-ci.sh

ddox/README-mysql-native.txt

@@ -1,13 +1,10 @@
 This copy of DDOX is included in the mysql-native repository for
 mysql-native's convenience.
 
-This is based on DDOX's 'v0.16.6' tag, with the following changes:
+This is based on DDOX's 'v0.16.12' tag, with the following changes:
 
 - Added this 'README-mysql-native.txt' file.
 
-- Modified 'dub.sdl' to include the version identifier 'VibeUseOpenSSL11' so
-it will succesfully link on my machine (Workaround DDOX Issue #186)
-
 - Modified 'layout.dt' and 'ddox.layout.dt' for mysql-native's purposes.
 (Workaround DDOX Issue #88)
 

ddox/dub.sdl

@@ -6,6 +6,16 @@ license "MIT"
 
 dependency "vibe-d:web" version=">=0.7.31 <0.9.0"
 dependency "hyphenate" version="~>1.1.0"
-dependency "libdparse" version="~>0.7.0"
+dependency "libdparse" version="~>0.8.0"
 
-versions "JsonLineNumbers" "VibeUseOpenSSL11"
+configuration "application" {
+	targetType "executable"
+	// Temporarily disabled to work around dlang/dub#1407
+	// mainSourceFile "source/app.d"
+	versions "JsonLineNumbers" "VibeNoSSL"
+}
+
+configuration "library" {
+	targetType "library"
+	excludedSourceFiles "source/app.d"
+}

ddox/dub.selections.json

@@ -1,18 +1,20 @@
 {
 	"fileVersion": 1,
 	"versions": {
-		"botan": "1.12.9",
+		"botan": "1.12.10",
 		"botan-math": "1.0.3",
-		"diet-ng": "1.4.3",
-		"eventcore": "0.8.17",
+		"diet-ng": "1.5.0",
+		"eventcore": "0.8.35",
 		"hyphenate": "1.1.1",
 		"libasync": "0.8.3",
-		"libdparse": "0.7.1",
+		"libdparse": "0.8.7",
 		"libevent": "2.0.2+2.0.16",
-		"memutils": "0.4.9",
-		"openssl": "1.1.5+1.0.1g",
-		"taggedalgebraic": "0.10.7",
-		"vibe-core": "1.2.0",
-		"vibe-d": "0.8.1"
+		"memutils": "0.4.11",
+		"mir-linux-kernel": "1.0.0",
+		"openssl": "1.1.6+1.0.1g",
+		"stdx-allocator": "2.77.2",
+		"taggedalgebraic": "0.10.11",
+		"vibe-core": "1.4.0",
+		"vibe-d": "0.8.4"
 	}
 }

ddox/source/ddox/api.d

@@ -247,7 +247,7 @@ string getAttributeString(Declaration decl, AttributeStringKind kind)
 
 enum AttributeStringKind { normal, functionPrefix, functionSuffix }
 
-string[] declStyleClasses(Declaration decl)
+auto declStyleClasses(Declaration decl)
 {
 	string[] ret;
 	ret ~= decl.protection.to!string().toLower();
@@ -257,7 +257,7 @@ string[] declStyleClasses(Declaration decl)
 		if (tdecl.type.attributes.canFind("@property")) ret ~= "property";
 		if (tdecl.type.attributes.canFind("static")) ret ~= "static";
 	}
-	return ret;
+	return ret.join(" ");
 }
 
 string formatType()(CachedType type, scope string delegate(in Entity) link_to, bool include_code_tags = true)
@@ -380,6 +380,10 @@ void renderTemplateArgs(R)(ref R output, Declaration decl, scope string delegate
 			output.put(' ');
 		}
 		output.put(arg.name);
+		if (arg.specValue.length) {
+			output.highlightDCode(" : ");
+			output.highlightDCode(arg.specValue);
+		}
 		if (arg.defaultValue.length) {
 			output.highlightDCode(" = ");
 			output.highlightDCode(arg.defaultValue);

ddox/source/ddox/ddoc.d

@@ -207,7 +207,7 @@ class DdocComment {
 
 		foreach (s; m_sections) {
 			if (display_section && !display_section(s.name)) continue;
-			parseSection(dst, s.name, s.lines, context, hlevel, allmacros);
+			parseSection(dst, s.name, s.lines.dup, context, hlevel, allmacros);
 		}
 	}