OpenSim
/
OpenSimMirror
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improving documentation of AttachToAvatar and GetLine methods in LSL_Api.cs based on doxygen error output

0.7.5-pf-bulletsim
SignpostMarv 2012-10-29 11:45:47 +00:00 committed by Justin Clark-Casey (justincc)
parent ce448adf91
commit 0022f48d42
1 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
OpenSim/Region/ScriptEngine/Shared/Api/Implementation/LSL_Api.cs
View File

@ -3007,7 +3007,9 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api
/// <summary> /// <summary>
/// Attach the object containing this script to the avatar that owns it. /// Attach the object containing this script to the avatar that owns it.
/// </summary> /// </summary>
/// <param name='attachment'>The attachment point (e.g. ATTACH_CHEST)</param> /// <param name='attachmentPoint'>
/// The attachment point (e.g. <see cref="OpenSim.Region.ScriptEngine.Shared.ScriptBase.ScriptBaseClass.ATTACH_CHEST">ATTACH_CHEST</see>)
/// </param>
/// <returns>true if the attach suceeded, false if it did not</returns> /// <returns>true if the attach suceeded, false if it did not</returns>
public bool AttachToAvatar(int attachmentPoint) public bool AttachToAvatar(int attachmentPoint)
{ {
@ -5418,9 +5420,9 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api
} }
/// <summary> /// <summary>
/// Insert the list identified by <src> into the /// Insert the list identified by <paramref name="src"/> into the
/// list designated by <dest> such that the first /// list designated by <paramref name="dest"/> such that the first
/// new element has the index specified by <index> /// new element has the index specified by <paramref name="index"/>
/// </summary> /// </summary>
public LSL_List llListInsertList(LSL_List dest, LSL_List src, int index) public LSL_List llListInsertList(LSL_List dest, LSL_List src, int index)
@ -11520,7 +11522,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api
/// Get a notecard line. /// Get a notecard line.
/// </summary> /// </summary>
/// <param name="assetID"></param> /// <param name="assetID"></param>
/// <param name="line">Lines start at index 0</param> /// <param name="lineNumber">Lines start at index 0</param>
/// <returns></returns> /// <returns></returns>
public static string GetLine(UUID assetID, int lineNumber) public static string GetLine(UUID assetID, int lineNumber)
{ {
@ -11549,9 +11551,14 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api
/// Get a notecard line. /// Get a notecard line.
/// </summary> /// </summary>
/// <param name="assetID"></param> /// <param name="assetID"></param>
/// <param name="line">Lines start at index 0</param> /// <param name="lineNumber">Lines start at index 0</param>
/// <param name="maxLength">Maximum length of the returned line. Longer lines will be truncated</para> /// <param name="maxLength">
/// <returns></returns> /// Maximum length of the returned line.
/// </param>
/// <returns>
/// If the line length is longer than <paramref name="maxLength"/>,
/// the return string will be truncated.
/// </returns>
public static string GetLine(UUID assetID, int lineNumber, int maxLength) public static string GetLine(UUID assetID, int lineNumber, int maxLength)
{ {
string line = GetLine(assetID, lineNumber); string line = GetLine(assetID, lineNumber);