Skip to content

Commit c8f8d01

Browse files
committed
Document and organize a few more options.
1 parent c42bd6e commit c8f8d01

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

src/Generator/Options.cs

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,24 @@ public DriverOptions()
4242

4343
/// <summary>
4444
/// Set to true to simulate generating without actually writing
45-
/// any output to disk. This can be useful to activate while
46-
/// debugging the parser generator so generator bugs do not get
47-
/// in the way while iterating.
45+
/// any output to disk.
4846
/// </summary>
4947
public bool DryRun;
5048

49+
/// <summary>
50+
/// Whether the generated code should be automatically compiled.
51+
/// </summary>
52+
public bool CompileCode;
53+
54+
// Parser options
55+
56+
/// <summary>
57+
/// If this option is off (the default), each header is parsed separately
58+
/// which is much slower but safer because of a clean state of the preprocessor
59+
/// for each header.
60+
/// </summary>
61+
public bool UnityBuild { get; set; }
62+
5163
public Module SystemModule { get; }
5264
public List<Module> Modules { get; }
5365

@@ -61,7 +73,6 @@ public Module MainModule
6173
}
6274
}
6375

64-
// Parser options
6576
public List<string> Headers => MainModule.Headers;
6677

6778
// Library options
@@ -104,31 +115,20 @@ public string LibraryName
104115

105116
/// <summary>
106117
/// If set to true the CLI generator will use ObjectOverridesPass to create
107-
/// Equals, GetHashCode and (if the insertion operator &lt;&lt; is overloaded) ToString
108-
/// methods.
118+
/// Equals, GetHashCode and (if the insertion operator &lt;&lt; is overloaded)
119+
/// ToString methods.
109120
/// </summary>
110121
public bool GenerateObjectOverrides;
111122

112123
//List of include directories that are used but not generated
113124
public List<string> NoGenIncludeDirs;
114125

115-
/// <summary>
116-
/// Whether the generated C# code should be automatically compiled.
117-
/// </summary>
118-
public bool CompileCode;
119-
120126
/// <summary>
121127
/// Enable this option to enable generation of finalizers.
122128
/// Works in both CLI and C# backends.
123129
/// </summary>
124130
public bool GenerateFinalizers;
125131

126-
/// <summary>
127-
/// If this option is off (the default), each header is parsed separately which is much slower
128-
/// but safer because of a clean state of the preprocessor for each header.
129-
/// </summary>
130-
public bool UnityBuild { get; set; }
131-
132132
public string IncludePrefix;
133133
public Func<TranslationUnit, string> GenerateName;
134134
public string CommentPrefix;

0 commit comments

Comments
 (0)