diff options
author | SignpostMarv | 2012-10-29 11:45:47 +0000 |
---|---|---|
committer | Justin Clark-Casey (justincc) | 2013-01-04 21:49:30 +0000 |
commit | 0022f48d42362afc119a339ef1819ee3e5e7a00a (patch) | |
tree | 365705fcdc00ea745bbd920d122a3063816a7ba7 /OpenSim | |
parent | updating documentation in SampleMoneyModule based on doxygen error log output... (diff) | |
download | opensim-SC_OLD-0022f48d42362afc119a339ef1819ee3e5e7a00a.zip opensim-SC_OLD-0022f48d42362afc119a339ef1819ee3e5e7a00a.tar.gz opensim-SC_OLD-0022f48d42362afc119a339ef1819ee3e5e7a00a.tar.bz2 opensim-SC_OLD-0022f48d42362afc119a339ef1819ee3e5e7a00a.tar.xz |
Improving documentation of AttachToAvatar and GetLine methods in LSL_Api.cs based on doxygen error output
Diffstat (limited to '')
-rw-r--r-- | OpenSim/Region/ScriptEngine/Shared/Api/Implementation/LSL_Api.cs | 23 |
1 files changed, 15 insertions, 8 deletions
diff --git a/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/LSL_Api.cs b/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/LSL_Api.cs index d69551f..75749a9 100644 --- a/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/LSL_Api.cs +++ b/OpenSim/Region/ScriptEngine/Shared/Api/Implementation/LSL_Api.cs | |||
@@ -3007,7 +3007,9 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api | |||
3007 | /// <summary> | 3007 | /// <summary> |
3008 | /// Attach the object containing this script to the avatar that owns it. | 3008 | /// Attach the object containing this script to the avatar that owns it. |
3009 | /// </summary> | 3009 | /// </summary> |
3010 | /// <param name='attachment'>The attachment point (e.g. ATTACH_CHEST)</param> | 3010 | /// <param name='attachmentPoint'> |
3011 | /// The attachment point (e.g. <see cref="OpenSim.Region.ScriptEngine.Shared.ScriptBase.ScriptBaseClass.ATTACH_CHEST">ATTACH_CHEST</see>) | ||
3012 | /// </param> | ||
3011 | /// <returns>true if the attach suceeded, false if it did not</returns> | 3013 | /// <returns>true if the attach suceeded, false if it did not</returns> |
3012 | public bool AttachToAvatar(int attachmentPoint) | 3014 | public bool AttachToAvatar(int attachmentPoint) |
3013 | { | 3015 | { |
@@ -5418,9 +5420,9 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api | |||
5418 | } | 5420 | } |
5419 | 5421 | ||
5420 | /// <summary> | 5422 | /// <summary> |
5421 | /// Insert the list identified by <src> into the | 5423 | /// Insert the list identified by <paramref name="src"/> into the |
5422 | /// list designated by <dest> such that the first | 5424 | /// list designated by <paramref name="dest"/> such that the first |
5423 | /// new element has the index specified by <index> | 5425 | /// new element has the index specified by <paramref name="index"/> |
5424 | /// </summary> | 5426 | /// </summary> |
5425 | 5427 | ||
5426 | public LSL_List llListInsertList(LSL_List dest, LSL_List src, int index) | 5428 | public LSL_List llListInsertList(LSL_List dest, LSL_List src, int index) |
@@ -11520,7 +11522,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api | |||
11520 | /// Get a notecard line. | 11522 | /// Get a notecard line. |
11521 | /// </summary> | 11523 | /// </summary> |
11522 | /// <param name="assetID"></param> | 11524 | /// <param name="assetID"></param> |
11523 | /// <param name="line">Lines start at index 0</param> | 11525 | /// <param name="lineNumber">Lines start at index 0</param> |
11524 | /// <returns></returns> | 11526 | /// <returns></returns> |
11525 | public static string GetLine(UUID assetID, int lineNumber) | 11527 | public static string GetLine(UUID assetID, int lineNumber) |
11526 | { | 11528 | { |
@@ -11549,9 +11551,14 @@ namespace OpenSim.Region.ScriptEngine.Shared.Api | |||
11549 | /// Get a notecard line. | 11551 | /// Get a notecard line. |
11550 | /// </summary> | 11552 | /// </summary> |
11551 | /// <param name="assetID"></param> | 11553 | /// <param name="assetID"></param> |
11552 | /// <param name="line">Lines start at index 0</param> | 11554 | /// <param name="lineNumber">Lines start at index 0</param> |
11553 | /// <param name="maxLength">Maximum length of the returned line. Longer lines will be truncated</para> | 11555 | /// <param name="maxLength"> |
11554 | /// <returns></returns> | 11556 | /// Maximum length of the returned line. |
11557 | /// </param> | ||
11558 | /// <returns> | ||
11559 | /// If the line length is longer than <paramref name="maxLength"/>, | ||
11560 | /// the return string will be truncated. | ||
11561 | /// </returns> | ||
11555 | public static string GetLine(UUID assetID, int lineNumber, int maxLength) | 11562 | public static string GetLine(UUID assetID, int lineNumber, int maxLength) |
11556 | { | 11563 | { |
11557 | string line = GetLine(assetID, lineNumber); | 11564 | string line = GetLine(assetID, lineNumber); |