From: Gert D. <dri...@us...> - 2003-08-31 12:03:06
|
Update of /cvsroot/nant/nant/src/NAnt.Core/Tasks In directory sc8-pr-cvs1:/tmp/cvs-serv26600 Modified Files: AttribTask.cs AvailableTask.cs CallTask.cs CopyTask.cs ExecTask.cs ExternalProgramBase.cs GetTask.cs IfTask.cs NAntTask.cs PropertyTask.cs TouchTask.cs Log Message: xml doc updates use <see langword="..." /> to refer to true or false values use StringUtils.ConvertEmptyToNull instead of SetStringValue to convert empty strings to a null value use StringUtils.IsNullOrEmpty to check whether a string is null or an empty string Index: AttribTask.cs =================================================================== RCS file: /cvsroot/nant/nant/src/NAnt.Core/Tasks/AttribTask.cs,v retrieving revision 1.12 retrieving revision 1.13 diff -C2 -d -r1.12 -r1.13 *** AttribTask.cs 30 Aug 2003 15:31:08 -0000 1.12 --- AttribTask.cs 31 Aug 2003 12:03:02 -0000 1.13 *************** *** 104,108 **** /// <summary> ! /// Set the archive attribute. Default is <c>false</c>. /// </summary> [TaskAttribute("archive")] --- 104,108 ---- /// <summary> ! /// Set the archive attribute. The default is <see langword="false" />. /// </summary> [TaskAttribute("archive")] *************** *** 114,118 **** /// <summary> ! /// Set the hidden attribute. Default is <c>false</c>. /// </summary> [TaskAttribute("hidden")] --- 114,118 ---- /// <summary> ! /// Set the hidden attribute. The default is <see langword="false" />. /// </summary> [TaskAttribute("hidden")] *************** *** 125,129 **** /// <summary> /// Set the normal file attributes. This attribute is only valid if used ! /// alone. Default is <c>false</c>. /// </summary> [TaskAttribute("normal")] --- 125,129 ---- /// <summary> /// Set the normal file attributes. This attribute is only valid if used ! /// alone. The default is <see langword="false" />. /// </summary> [TaskAttribute("normal")] *************** *** 135,139 **** /// <summary> ! /// Set the read-only attribute. Default is <c>false</c>. /// </summary> [TaskAttribute("readonly")] --- 135,139 ---- /// <summary> ! /// Set the read-only attribute. The default is <see langword="false" />. /// </summary> [TaskAttribute("readonly")] *************** *** 145,149 **** /// <summary> ! /// Set the system attribute. Default is <c>false</c>. /// </summary> [TaskAttribute("system")] --- 145,149 ---- /// <summary> ! /// Set the system attribute. The default is <see langword="false" />. /// </summary> [TaskAttribute("system")] Index: AvailableTask.cs =================================================================== RCS file: /cvsroot/nant/nant/src/NAnt.Core/Tasks/AvailableTask.cs,v retrieving revision 1.16 retrieving revision 1.17 diff -C2 -d -r1.16 -r1.17 *** AvailableTask.cs 30 Aug 2003 15:31:08 -0000 1.16 --- AvailableTask.cs 31 Aug 2003 12:03:02 -0000 1.17 *************** *** 31,41 **** /// </summary> /// <remarks> ! /// The specified property is set to <c>true</c> if the requested resource ! /// is available at runtime, and <c>false</c> if the resource is not available. /// </remarks> /// <example> /// <para> ! /// Sets the <c>myfile.present</c> property to <c>true</c> if the file is ! /// available on the filesystem and <c>false</c> if the file is not available. /// </para> /// <code> --- 31,43 ---- /// </summary> /// <remarks> ! /// The specified property is set to <see langword="true" /> if the requested ! /// resource is available at runtime, and <see langword="false" /> if the ! /// resource is not available. /// </remarks> /// <example> /// <para> ! /// Sets the <c>myfile.present</c> property to <see langword="true" /> if the ! /// file is available on the filesystem and <see langword="false" /> if the ! /// file is not available. /// </para> /// <code> *************** *** 45,51 **** /// </code> /// <para> ! /// Sets the <c>build.dir.present</c> property to <c>true</c> if the ! /// directory is available on the filesystem and <c>false</c> if the ! /// directory is not available. /// </para> /// <code> --- 47,53 ---- /// </code> /// <para> ! /// Sets the <c>build.dir.present</c> property to <see langword="true" /> ! /// if the directory is available on the filesystem and <see langword="false" /> ! /// if the directory is not available. /// </para> /// <code> *************** *** 55,61 **** /// </code> /// <para> ! /// Sets the <c>mono-0.21.framework.present</c> property to <c>true</c> /// if the Mono 0.21 framework is available on the current system and ! /// <c>false</c> if the framework is not available. /// </para> /// <code> --- 57,63 ---- /// </code> /// <para> ! /// Sets the <c>mono-0.21.framework.present</c> property to <see langword="true" /> /// if the Mono 0.21 framework is available on the current system and ! /// <see langword="false" /> if the framework is not available. /// </para> /// <code> *************** *** 65,71 **** /// </code> /// <para> ! /// Sets the <c>net-1.1.frameworksdk.present</c> property to <c>true</c> /// if the .NET 1.1 Framework SDK is available on the current system and ! /// <c>false</c> if the SDK is not available. /// </para> /// <code> --- 67,73 ---- /// </code> /// <para> ! /// Sets the <c>net-1.1.frameworksdk.present</c> property to <see langword="true" /> /// if the .NET 1.1 Framework SDK is available on the current system and ! /// <see langword="false" /> if the SDK is not available. /// </para> /// <code> *************** *** 149,154 **** /// <para> /// Sets the property identified by <see cref="PropertyName" /> to ! /// <c>true</c> when the resource exists and to <c>false</c> when the ! /// resource doesn't exist. /// </para> /// </remarks> --- 151,156 ---- /// <para> /// Sets the property identified by <see cref="PropertyName" /> to ! /// <see langword="true" /> when the resource exists and to <see langword="false" /> ! /// when the resource doesn't exist. /// </para> /// </remarks> *************** *** 166,170 **** /// </summary> /// <returns> ! /// <c>true</c> if the resource is available; otherwise, <c>false</c>. /// </returns> /// <exception cref="BuildException">The availability of the resource could not be evaluated.</exception> --- 168,173 ---- /// </summary> /// <returns> ! /// <see langword="true" /> if the resource is available; otherwise, ! /// <see langword="false" />. /// </returns> /// <exception cref="BuildException">The availability of the resource could not be evaluated.</exception> *************** *** 205,209 **** /// </summary> /// <returns> ! /// <c>true</c> when the file exists; otherwise, <c>false</c>. /// </returns> private bool CheckFile() { --- 208,212 ---- /// </summary> /// <returns> ! /// <see langword="true" /> when the file exists; otherwise, <see langword="false" />. /// </returns> private bool CheckFile() { *************** *** 224,228 **** /// </summary> /// <returns> ! /// <c>true</c> when the directory exists; otherwise, <c>false</c>. /// </returns> private bool CheckDirectory() { --- 227,231 ---- /// </summary> /// <returns> ! /// <see langword="true" /> when the directory exists; otherwise, <see langword="false" />. /// </returns> private bool CheckDirectory() { *************** *** 243,247 **** /// </summary> /// <returns> ! /// <c>true</c> when the framework is available, <c>false</c> otherwise. /// </returns> private bool CheckFramework() { --- 246,251 ---- /// </summary> /// <returns> ! /// <see langword="true" /> when the framework is available; otherwise, ! /// <see langword="false" />. /// </returns> private bool CheckFramework() { *************** *** 254,259 **** /// </summary> /// <returns> ! /// <c>true</c> when the SDK for the specified framework is available; ! /// otherwise, <c>false</c>. /// </returns> private bool CheckFrameworkSDK() { --- 258,263 ---- /// </summary> /// <returns> ! /// <see langword="true" /> when the SDK for the specified framework is ! /// available; otherwise, <see langword="false" />. /// </returns> private bool CheckFrameworkSDK() { Index: CallTask.cs =================================================================== RCS file: /cvsroot/nant/nant/src/NAnt.Core/Tasks/CallTask.cs,v retrieving revision 1.7 retrieving revision 1.8 diff -C2 -d -r1.7 -r1.8 *** CallTask.cs 30 Aug 2003 15:31:08 -0000 1.7 --- CallTask.cs 31 Aug 2003 12:03:02 -0000 1.8 *************** *** 71,75 **** /// <summary> /// Force a execute even if the target has already been executed. ! /// Default is <c>false</c>. /// </summary> [TaskAttribute("force")] --- 71,75 ---- /// <summary> /// Force a execute even if the target has already been executed. ! /// The default is <see langword="false" />. /// </summary> [TaskAttribute("force")] Index: CopyTask.cs =================================================================== RCS file: /cvsroot/nant/nant/src/NAnt.Core/Tasks/CopyTask.cs,v retrieving revision 1.21 retrieving revision 1.22 diff -C2 -d -r1.21 -r1.22 *** CopyTask.cs 30 Aug 2003 15:31:08 -0000 1.21 --- CopyTask.cs 31 Aug 2003 12:03:02 -0000 1.22 *************** *** 109,113 **** /// <summary> /// Overwrite existing files even if the destination files are newer. ! /// Defaults to <c>false</c>. /// </summary> [TaskAttribute("overwrite")] --- 109,113 ---- /// <summary> /// Overwrite existing files even if the destination files are newer. ! /// The default is <see langword="false" />. /// </summary> [TaskAttribute("overwrite")] Index: ExecTask.cs =================================================================== RCS file: /cvsroot/nant/nant/src/NAnt.Core/Tasks/ExecTask.cs,v retrieving revision 1.17 retrieving revision 1.18 diff -C2 -d -r1.17 -r1.18 *** ExecTask.cs 30 Aug 2003 15:32:15 -0000 1.17 --- ExecTask.cs 31 Aug 2003 12:03:02 -0000 1.18 *************** *** 102,110 **** /// <summary> /// Specifies whether the external program should be executed using a ! /// runtime engine, if configured. Default is <c>false</c>. /// </summary> /// <value> ! /// <c>true</c> if the external program should be executed using a ! /// runtime engine; otherwise, <c>false</c>. /// </value> [TaskAttribute("useruntimeengine")] --- 102,110 ---- /// <summary> /// Specifies whether the external program should be executed using a ! /// runtime engine, if configured. The default is <see langword="false" />. /// </summary> /// <value> ! /// <see langword="true" /> if the external program should be executed ! /// using a runtime engine; otherwise, <see langword="false" />. /// </value> [TaskAttribute("useruntimeengine")] *************** *** 168,176 **** /// <summary> /// Gets or sets a value indicating whether output should be appended ! /// to the output file. Default value is <c>false</c>. /// </summary> /// <value> ! /// <c>true</c> if output should be appended to the <see cref="OutputFile" />; ! /// otherwise, <c>false</c>. /// </value> [TaskAttribute("append", Required=false)] --- 168,176 ---- /// <summary> /// Gets or sets a value indicating whether output should be appended ! /// to the output file. The default is <see langword="false" />. /// </summary> /// <value> ! /// <see langword="true" /> if output should be appended to the <see cref="OutputFile" />; ! /// otherwise, <see langword="false" />. /// </value> [TaskAttribute("append", Required=false)] Index: ExternalProgramBase.cs =================================================================== RCS file: /cvsroot/nant/nant/src/NAnt.Core/Tasks/ExternalProgramBase.cs,v retrieving revision 1.40 retrieving revision 1.41 diff -C2 -d -r1.40 -r1.41 *** ExternalProgramBase.cs 23 Aug 2003 13:31:34 -0000 1.40 --- ExternalProgramBase.cs 31 Aug 2003 12:03:02 -0000 1.41 *************** *** 32,35 **** --- 32,36 ---- using NAnt.Core.Attributes; using NAnt.Core.Types; + using NAnt.Core.Util; namespace NAnt.Core.Tasks { *************** *** 121,126 **** /// </summary> /// <value> ! /// <c>true</c> if output should be appended to the <see cref="OutputFile" />; ! /// otherwise, <c>false</c>. /// </value> public virtual bool OutputAppend { --- 122,127 ---- /// </summary> /// <value> ! /// <see langword="true" /> if output should be appended to the <see cref="OutputFile" />; ! /// otherwise, <see langword="false" />. /// </value> public virtual bool OutputAppend { *************** *** 167,175 **** /// <summary> /// Specifies whether the external program should be executed using a ! /// runtime engine, if configured. Default is <c>false</c>. /// </summary> /// <value> ! /// <c>true</c> if the external program should be executed using a ! /// runtime engine; otherwise, <c>false</c>. /// </value> [FrameworkConfigurable("useruntimeengine")] --- 168,176 ---- /// <summary> /// Specifies whether the external program should be executed using a ! /// runtime engine, if configured. The Default is <see langword="false" />. /// </summary> /// <value> ! /// <see langword="true" /> if the external program should be executed ! /// using a runtime engine; otherwise, <see langword="false" />. /// </value> [FrameworkConfigurable("useruntimeengine")] *************** *** 354,358 **** Log(Level.Info, new string(char.Parse(" "), LogPrefix.Length) + strLogContents); ! if (OutputFile != null && OutputFile.Length != 0) { StreamWriter writer = new StreamWriter(OutputFile, doAppend); writer.WriteLine(strLogContents); --- 355,359 ---- Log(Level.Info, new string(char.Parse(" "), LogPrefix.Length) + strLogContents); ! if (!StringUtils.IsNullOrEmpty(OutputFile)) { StreamWriter writer = new StreamWriter(OutputFile, doAppend); writer.WriteLine(strLogContents); *************** *** 379,383 **** Log(Level.Info, new string(char.Parse(" "), LogPrefix.Length) + strLogContents); ! if (OutputFile != null && OutputFile.Length != 0) { StreamWriter writer = new StreamWriter(OutputFile, OutputAppend); writer.Write(strLogContents); --- 380,384 ---- Log(Level.Info, new string(char.Parse(" "), LogPrefix.Length) + strLogContents); ! if (!StringUtils.IsNullOrEmpty(OutputFile)) { StreamWriter writer = new StreamWriter(OutputFile, OutputAppend); writer.Write(strLogContents); Index: GetTask.cs =================================================================== RCS file: /cvsroot/nant/nant/src/NAnt.Core/Tasks/GetTask.cs,v retrieving revision 1.11 retrieving revision 1.12 diff -C2 -d -r1.11 -r1.12 *** GetTask.cs 23 Aug 2003 13:31:34 -0000 1.11 --- GetTask.cs 31 Aug 2003 12:03:02 -0000 1.12 *************** *** 93,97 **** /// <summary> ! /// Log errors but don't treat as fatal. Default is <c>false</c>. /// </summary> [TaskAttribute("ignoreerrors")] --- 93,97 ---- /// <summary> ! /// Log errors but don't treat as fatal. The default is <see langword="false" />. /// </summary> [TaskAttribute("ignoreerrors")] *************** *** 104,108 **** /// <summary> /// Conditionally download a file based on the timestamp of the local ! /// copy. HTTP only. Default is <c>false</c>. /// </summary> [TaskAttribute("usetimestamp")] --- 104,108 ---- /// <summary> /// Conditionally download a file based on the timestamp of the local ! /// copy. HTTP only. The default is <see langword="false" />. /// </summary> [TaskAttribute("usetimestamp")] Index: IfTask.cs =================================================================== RCS file: /cvsroot/nant/nant/src/NAnt.Core/Tasks/IfTask.cs,v retrieving revision 1.21 retrieving revision 1.22 diff -C2 -d -r1.21 -r1.22 *** IfTask.cs 30 Aug 2003 15:32:15 -0000 1.21 --- IfTask.cs 31 Aug 2003 12:03:02 -0000 1.22 *************** *** 28,32 **** namespace NAnt.Core.Tasks { /// <summary> ! /// Checks the conditional attributes and executes the children if <c>true</c>. /// </summary> /// <remarks> --- 28,33 ---- namespace NAnt.Core.Tasks { /// <summary> ! /// Checks the conditional attributes and executes the children if ! /// <see langword="true" />. /// </summary> /// <remarks> *************** *** 75,79 **** /// <example> /// <para> ! /// Check that a property exists and is <c>true</c> (uses multiple conditions). /// </para> /// <code> --- 76,80 ---- /// <example> /// <para> ! /// Check that a property exists and is <see langword="true" /> (uses multiple conditions). /// </para> /// <code> Index: NAntTask.cs =================================================================== RCS file: /cvsroot/nant/nant/src/NAnt.Core/Tasks/NAntTask.cs,v retrieving revision 1.16 retrieving revision 1.17 diff -C2 -d -r1.16 -r1.17 *** NAntTask.cs 23 Aug 2003 13:31:35 -0000 1.16 --- NAntTask.cs 31 Aug 2003 12:03:02 -0000 1.17 *************** *** 29,33 **** /// </summary> /// <example> ! /// <para>Build a project located in a different directory if the <c>debug</c> property is not <c>true</c>.</para> /// <code> /// <![CDATA[ --- 29,36 ---- /// </summary> /// <example> ! /// <para> ! /// Build a project located in a different directory if the <c>debug</c> ! /// property is not <see langword="true" />. ! /// </para> /// <code> /// <![CDATA[ *************** *** 75,79 **** /// <summary> /// Specifies whether current property values should be inherited by ! /// the executed project. Default is <c>false</c>. /// </summary> [TaskAttribute("inheritall"), BooleanValidator()] --- 78,82 ---- /// <summary> /// Specifies whether current property values should be inherited by ! /// the executed project. The default is <see langword="false" />. /// </summary> [TaskAttribute("inheritall"), BooleanValidator()] Index: PropertyTask.cs =================================================================== RCS file: /cvsroot/nant/nant/src/NAnt.Core/Tasks/PropertyTask.cs,v retrieving revision 1.11 retrieving revision 1.12 diff -C2 -d -r1.11 -r1.12 *** PropertyTask.cs 23 Aug 2003 13:31:35 -0000 1.11 --- PropertyTask.cs 31 Aug 2003 12:03:02 -0000 1.12 *************** *** 34,38 **** /// <example> /// <para> ! /// Define a <c>debug</c> property with value <c>true</c>. /// </para> /// <code> --- 34,38 ---- /// <example> /// <para> ! /// Define a <c>debug</c> property with value <see langword="true" />. /// </para> /// <code> *************** *** 92,96 **** /// <summary> /// Specifies whether the property is read-only or not. ! /// Default is <c>false</c>. /// </summary> [TaskAttribute("readonly", Required=false)] --- 92,96 ---- /// <summary> /// Specifies whether the property is read-only or not. ! /// The default is <see langword="false" />. /// </summary> [TaskAttribute("readonly", Required=false)] *************** *** 104,108 **** /// Specifies whether the value of a property should be overwritten if /// the property already exists (unless the property is readonly). ! /// Default is <c>true</c>. /// </summary> [TaskAttribute("overwrite", Required=false)] --- 104,108 ---- /// Specifies whether the value of a property should be overwritten if /// the property already exists (unless the property is readonly). ! /// The default is <see langword="true" />. /// </summary> [TaskAttribute("overwrite", Required=false)] Index: TouchTask.cs =================================================================== RCS file: /cvsroot/nant/nant/src/NAnt.Core/Tasks/TouchTask.cs,v retrieving revision 1.11 retrieving revision 1.12 diff -C2 -d -r1.11 -r1.12 *** TouchTask.cs 23 Aug 2003 13:31:35 -0000 1.11 --- TouchTask.cs 31 Aug 2003 12:03:02 -0000 1.12 *************** *** 25,28 **** --- 25,29 ---- using NAnt.Core.Attributes; using NAnt.Core.Types; + using NAnt.Core.Util; namespace NAnt.Core.Tasks { *************** *** 165,169 **** DateTime touchDateTime = new DateTime(); ! if (dateText.Length != 0) { touchDateTime = DateTime.Parse(dateText, CultureInfo.InvariantCulture); } else { --- 166,170 ---- DateTime touchDateTime = new DateTime(); ! if (!StringUtils.IsNullOrEmpty(dateText)) { touchDateTime = DateTime.Parse(dateText, CultureInfo.InvariantCulture); } else { |