Skip to content

Commit

Permalink
WiX4: Improved the documentation for AutoElements and `Compiler.Aut…
Browse files Browse the repository at this point in the history
…oGeneration` (triggered by #1578)
  • Loading branch information
oleg-shilo committed Jul 10, 2024
1 parent fef11e6 commit 0e3f947
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 3 deletions.
5 changes: 5 additions & 0 deletions Source/src/WixSharp/AutoElements.cs
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,11 @@ public enum CompilerSupportState
/// </para>
/// <para>The following link is a good example of the technique:
/// http://stackoverflow.com/questions/16119708/component-testcomp-installs-to-user-profile-it-must-use-a-registry-key-under-hk</para>
/// <para>
/// Note, there is also additional configuration settings class that controls other aspects of auto-generation:
/// <see cref="WixSharp.Compiler.AutoGeneration"/>. The reason for two classes is not strong and rather legacy-based.
/// The intention is to merge them together in the near future (as of 10-Jul-204).
/// </para>
/// </summary>
public static class AutoElements
{
Expand Down
22 changes: 19 additions & 3 deletions Source/src/WixSharp/Compiler.cs
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,15 @@ THE SOFTWARE.
namespace WixSharp
{
/// <summary>
/// This class holds the settings for Wix# XML auto-generation: generation of WiX XML elements, which do not have direct
/// representation in the Wix# script. The detailed information about Wix# auto-generation can be found here: http://www.csscript.net/WixSharp/ID_Allocation.html.
/// This class holds the settings for various WixSharp auto-generation aspects that are not directly related to the
/// WXS XML schema. IE enforcement of ComponentId uniqness, ID allocation, etc.
/// <p>
/// The detailed information about Wix# auto-generation can be found
/// here: http://www.csscript.net/WixSharp/ID_Allocation.html.
/// </p>
/// <p> There is also additional configuration settings class that controls pure XML generation aspects:
/// <see cref="WixSharp.AutoElements"/>.
/// </p>
/// </summary>
public class AutoGenerationOptions
{
Expand Down Expand Up @@ -268,7 +275,16 @@ public partial class Compiler
/// </summary>
static public bool VerboseOutput;
/// <summary>
/// Contains settings for XML auto-generation.
/// Contains settings for XML auto-generation aspects that are directly related to the
/// WXS XML schema. IE enforcement of ComponentId uniqness, ID allocation, etc.
/// <p>
/// The detailed information about Wix# auto-generation can be found
/// here: http://www.csscript.net/WixSharp/ID_Allocation.html.
/// </p>
/// <p> Note, there is also additional configuration settings class that controls pure XML generation aspects:
/// <see cref="WixSharp.AutoElements"/>. The reason for two classes is not strong and rather legacy-based.
/// The intention is to merge them together in the near future (as of 10-Jul-204).
/// </p>
/// </summary>
static public AutoGenerationOptions AutoGeneration { get => autoGeneration; }

Expand Down

0 comments on commit 0e3f947

Please sign in to comment.