Add --include-private flag to show private fields and types (#267)

HaxeFoundation · Mar 6, 2020 · 302a655 · 302a655
1 parent d2cb38e
commit 302a655
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 2 deletions.
diff --git a/run.n b/run.n
diff --git a/src/dox/Config.hx b/src/dox/Config.hx
@@ -10,6 +10,7 @@ class Config {
 	public var rootPath:String;
 	public var toplevelPackage:String;
 	public var useMarkdown:Bool;
+	public var includePrivate:Bool;
 	public var date:Date;
 	public var outputPath(default, set):String = "pages";
 	public var xmlPath(default, set):String = "xml";
@@ -34,6 +35,7 @@ class Config {
 		resourcePaths = [];
 		toplevelPackage = "";
 		useMarkdown = true;
+		includePrivate = false;
 		defines = new Map();
 		pathFilters = new GenericStack<Filter>();
 		templatePaths = new GenericStack<String>();

diff --git a/src/dox/Dox.hx b/src/dox/Dox.hx
@@ -65,6 +65,9 @@ class Dox {
 			@doc("Disable markdown rendering")
 			["--no-markdown"] => function() cfg.useMarkdown = false,
 
+			@doc("Include private fields and types")
+			["--include-private"] => function() cfg.includePrivate = true,
+
 			@doc("Set the theme name or path")
 			["-theme"] => function(name:String) cfg.loadTheme(owd, name),
 

diff --git a/src/dox/Processor.hx b/src/dox/Processor.hx
@@ -116,7 +116,7 @@ class Processor {
 			var show = Infos.hasDoxMetadata(cf.meta, "show");
 			var compilerGenerated = cf.meta.exists(function(struct) return struct.name == ":compilerGenerated");
 
-			return (cf.isPublic && !hide && !compilerGenerated) || show;
+			return ((cf.isPublic || config.includePrivate) && !hide && !compilerGenerated) || show;
 		});
 	}
 
@@ -310,7 +310,7 @@ class Processor {
 		if (Infos.hasDoxMetadata(type.meta, "hide"))
 			return true;
 		if (type.isPrivate)
-			return true;
+			return !config.includePrivate;
 		return isPathFiltered(type.path);
 	}