Add a --keep-field-order argument

closes #258

CHANGELOG.md

@@ -3,6 +3,7 @@
 - added a "final" prefix for final classes and interfaces
 - added support for deprecation messages on types ([#261](https://github.com/HaxeFoundation/dox/issues/261))
 - added support for `@:noCompletion` implying `@:dox(hide)` ([#250](https://github.com/HaxeFoundation/dox/issues/250))
+- added a `--keep-field-order` argument ([#258](https://github.com/HaxeFoundation/dox/issues/258))
 - improved function type printing to use Haxe 4 syntax ([#273](https://github.com/HaxeFoundation/dox/issues/273))
 - fixed JS version being used if the node version is not supported (< 8.10.0)
 - fixed interfaces with multiple `extends` only showing the first one ([#260](https://github.com/HaxeFoundation/dox/issues/260))

src/dox/Api.hx

@@ -32,8 +32,8 @@ class Api {
 	public var currentPageUrl:Null<String>;
 
 	/**
-	 * Expose Std for theme.
-	 */
+		Expose Std for theme.
+	**/
 	public var std = Std;
 
 	public function new(cfg:Config, infos:Infos) {
@@ -380,8 +380,7 @@ class Api {
 	}
 
 	/**
-		Returns an array of all member fields of `c` respecting the inheritance
-		chain.
+		Returns an array of all member fields of `c` respecting the inheritance chain.
 	**/
 	public function getAllFields(c:Classdef):Array<MemberField> {
 		var allFields = [];
@@ -401,7 +400,9 @@ class Api {
 			}
 		}
 		loop(c);
-		allFields.sort((f1, f2) -> Reflect.compare(f1.field.name, f2.field.name));
+		if (!config.keepFieldOrder) {
+			allFields.sort((f1, f2) -> Reflect.compare(f1.field.name, f2.field.name));
+		}
 		return allFields;
 	}
 
@@ -450,11 +451,14 @@ class Api {
 			else
 				addFieldTo(f, inheritedFields.fields);
 		}
-		for (fields in inheritedFields.methods) {
-			fields.sort((f1, f2) -> Reflect.compare(f1.name, f2.name));
-		}
-		for (fields in inheritedFields.fields) {
-			fields.sort((f1, f2) -> Reflect.compare(f1.name, f2.name));
+
+		if (!config.keepFieldOrder) {
+			for (fields in inheritedFields.methods) {
+				fields.sort((f1, f2) -> Reflect.compare(f1.name, f2.name));
+			}
+			for (fields in inheritedFields.fields) {
+				fields.sort((f1, f2) -> Reflect.compare(f1.name, f2.name));
+			}
 		}
 
 		return inheritedFields;
@@ -472,12 +476,12 @@ typedef FieldInfo = {
 	/**
 		The kind of the field. See `FieldKind`.
 	**/
-	kind:FieldKind,
+	var kind:FieldKind;
 
 	/**
 		The field modifiers. See `FieldModifiers`.
 	**/
-	modifiers:FieldModifiers
+	var modifiers:FieldModifiers;
 }
 
 /**

src/dox/Config.hx

@@ -21,6 +21,7 @@ class Config {
 	public var toplevelPackage:String;
 	public var useMarkdown:Bool;
 	public var includePrivate:Bool;
+	public var keepFieldOrder:Bool;
 	public var date:Date;
 	public var outputPath(default, set):String = "pages";
 	public var inputPath(default, set):String = "xml";
@@ -46,6 +47,7 @@ class Config {
 		toplevelPackage = "";
 		useMarkdown = true;
 		includePrivate = false;
+		keepFieldOrder = false;
 		defines = new Map();
 		pathFilters = new GenericStack<Filter>();
 		templatePaths = new GenericStack<String>();

src/dox/Dox.hx

@@ -75,6 +75,9 @@ class Dox {
 			@doc("Include private fields and types")
 			["--include-private"] => function() cfg.includePrivate = true,
 
+			@doc("Don't sort fields alphabetically")
+			["--keep-field-order"] => function() cfg.keepFieldOrder = true,
+
 			@doc("Set the theme name or path")
 			["-theme"] => function(name:String) cfg.loadTheme(owd, name),
 

src/dox/Processor.hx

@@ -160,7 +160,9 @@ class Processor {
 			}
 
 		inline function sortFields(fields:Array<ClassField>) {
-			return fields.sort(compareFields);
+			if (!config.keepFieldOrder) {
+				fields.sort(compareFields);
+			}
 		}
 
 		function sort(t:TypeTree) {