Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

WIP: Fix WiX API page #817

Merged
merged 2 commits into from
May 26, 2015
Merged

WIP: Fix WiX API page #817

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bed1d73
Added missing type descriptions
May 26, 2015
7849400
Fixed sample code in comments
May 26, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion src/app/FakeLib/WiXHelper.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,7 @@ let WiXDefaults : WiXParams =
AdditionalCandleArgs = [ "-ext WiXNetFxExtension" ]
AdditionalLightArgs = [ "-ext WiXNetFxExtension"; "-ext WixUIExtension.dll"; "-ext WixUtilExtension.dll" ] }

/// These are used in many methods for generating WiX nodes, regard them as booleans
type YesOrNo =
| Yes
| No
Expand All @@ -153,6 +154,7 @@ type YesOrNo =
| Yes -> "yes"
| No -> "no"

/// Used for determing whether the feature should be visible in the select features installer pane or not
type FeatureDisplay =
/// Initially shows the feature collapsed. This is the default value.
| Collapse
Expand Down Expand Up @@ -285,6 +287,7 @@ let WiXScriptDefaults =
ActionSequences = ""
}

/// Used in WiXCustomAction for determing when to run the custom action
type CustomActionExecute =
/// Indicates that the custom action will run after successful completion of the installation script (at the end of the installation).
| Commit
Expand All @@ -310,6 +313,7 @@ type CustomActionExecute =
| Rollback -> "rollback"
| SecondSequence -> "secondSequence"

/// Used in WiXCustomAction for determing the return type
type CustomActionReturn =
/// Indicates that the custom action will run asyncronously and execution may continue after the installer terminates.
| AsyncNoWait
Expand Down Expand Up @@ -366,6 +370,7 @@ let WiXCustomActionDefaults =
Return = CustomActionReturn.Check
}

/// Used for specifying the point of time for action execution in WiXCustomActionExecution
type ActionExecutionVerb =
/// Specifies that action should be executed after some standard or custom action
| After
Expand Down Expand Up @@ -485,6 +490,7 @@ let WiXUpgradeVersionDefaults =
IncludeMaximum = YesOrNo.No
}

/// Used for determing when to run RemoveExistingProducts on major upgrade
type MajorUpgradeSchedule =
/// (Default) Schedules RemoveExistingProducts after the InstallValidate standard action. This scheduling removes the installed product entirely before installing the upgrade product.
/// It's slowest but gives the most flexibility in changing components and features in the upgrade product. Note that if the installation of the upgrade product fails,
Expand Down Expand Up @@ -539,6 +545,7 @@ let WiXMajorUpgradeDefaults =
/// You need to run this once every build an then use FillInWiXScript to replace placeholders
/// ## Parameters
/// - `fileName` - Pass desired fileName for your wiXScript file
///
/// ## Sample
/// generateWiXScript "Setup.wxs"
let generateWiXScript fileName =
Expand Down Expand Up @@ -604,8 +611,9 @@ let generateWiXScript fileName =
/// ## Parameters
/// - `wiXPath` - Pass path where your script is located at. Function will search for all Scripts in that location and fill in parameters
/// - `setParams` - Function used to manipulate the WiX default parameters.
///
/// ## Sample
/// FillInWixScript "" (fun f ->
/// FillInWixScript "" (fun f ->
/// {f with
/// ProductCode = WiXProductCode
/// ProductName = WiXProductName
Expand Down Expand Up @@ -648,6 +656,7 @@ let FillInWixScript wiXPath setParams =
/// You can pass other features into InnerContent for making a hierarchy
/// ## Parameters
/// - `setParams` - Function used to manipulate the WiX default parameters.
///
/// ## Sample
/// let feature = generateFeature (fun f ->
/// {f with
Expand All @@ -670,6 +679,7 @@ let generateFeature setParams =
/// ExeCommand are the parameters passed to your executable
/// ## Parameters
/// - `setParams` - Function used to manipulate the WiX default parameters.
///
/// ## Sample
/// let action = generateCustomAction (fun f ->
/// {f with
Expand All @@ -690,6 +700,7 @@ let generateCustomAction setParams =
/// Condition in sample makes execute only on install
/// ## Parameters
/// - `setParams` - Function used to manipulate the WiX default parameters.
///
/// ## Sample
/// let actionExecution = generateCustomActionExecution (fun f ->
/// {f with
Expand All @@ -707,6 +718,7 @@ let generateCustomActionExecution setParams =
/// Generates a ui ref based on the given parameters, use toString on it when embedding it
/// ## Parameters
/// - `setParams` - Function used to manipulate the WiX default parameters.
///
/// ## Sample
/// let UIRef = generateUIRef (fun f ->
/// {f with
Expand All @@ -722,6 +734,7 @@ let generateUIRef setParams =
/// Generates an upgrade based on the given parameters, use toString on it when embedding it
/// ## Parameters
/// - `setParams` - Function used to manipulate the WiX default parameters.
///
/// ## Sample
/// let upgrade = generateUpgrade (fun f ->
/// {f with
Expand All @@ -736,6 +749,7 @@ let generateUpgrade setParams =
/// Generates an upgrade version based on the given parameters, use toString on it when embedding it
/// ## Parameters
/// - `setParams` - Function used to manipulate the WiX default parameters.
///
/// ## Sample
/// let upgradeVersion = generateUpgradeVersion (fun f ->
/// {f with
Expand All @@ -750,6 +764,7 @@ let generateUpgradeVersion setParams =
/// Generates a major upgrade based on the given parameters, use toString on it when embedding it
/// ## Parameters
/// - `setParams` - Function used to manipulate the WiX default parameters.
///
/// ## Sample
/// let majorUpgradeVersion = generateMajorUpgradeVersion(fun f ->
/// {f with
Expand Down