فهرست منبع

Merge pull request #166 from thareh/master

Some bbdoc fixes
Brucey 5 سال پیش
والد
کامیت
af8897f34f

+ 1 - 0
blitz.mod/blitz.bmx

@@ -388,6 +388,7 @@ Function Delay( millis:Int )="bbDelay"
 
 
 Rem
 Rem
 bbdoc: Wait for a given number of microseconds
 bbdoc: Wait for a given number of microseconds
+about:
 #UDelay suspends program execution for at least @microcseconds.<br>
 #UDelay suspends program execution for at least @microcseconds.<br>
 <br>
 <br>
 A microsecond is one millionth of a second.
 A microsecond is one millionth of a second.

+ 6 - 1
blitz.mod/iterator.bmx

@@ -1,10 +1,15 @@
-
+Rem
+bbdoc: Iterable interface
+EndRem
 Interface IIterable<T>
 Interface IIterable<T>
 
 
 	Method GetIterator:IIterator<T>()
 	Method GetIterator:IIterator<T>()
 
 
 End Interface
 End Interface
 
 
+Rem
+bbdoc: Iterator interface
+EndRem
 Interface IIterator<T>
 Interface IIterator<T>
 
 
 	Method Current:T()
 	Method Current:T()

+ 1 - 1
collections.mod/linkedlist.bmx

@@ -232,7 +232,7 @@ Public
 	
 	
 	Rem
 	Rem
 	bbdoc: Determines whether @value is in the #TLinkedList.
 	bbdoc: Determines whether @value is in the #TLinkedList.
-	returns: #True if @value is in the #TLinkedList, or #Fale otherwise.
+	returns: #True if @value is in the #TLinkedList, or #False otherwise.
 	End Rem
 	End Rem
 	Method Contains:Int(value:T)
 	Method Contains:Int(value:T)
 		Return Find(value) <> Null
 		Return Find(value) <> Null

+ 1 - 1
collections.mod/list.bmx

@@ -139,7 +139,7 @@ Public
 	End Method
 	End Method
 	
 	
 	Rem
 	Rem
-	bbdoc: Returns the zero-based index of the first occurrence of a value in the #List.
+	bbdoc: Returns the zero-based index of the first occurrence of a value in the #TArrayList.
 	End Rem
 	End Rem
 	Method IndexOf:Int(element:T) Override
 	Method IndexOf:Int(element:T) Override
 		For Local i:Int = 0 Until size
 		For Local i:Int = 0 Until size

+ 1 - 1
collections.mod/set.bmx

@@ -197,7 +197,7 @@ Type TSet<T> Implements ISet<T>
 	Rem
 	Rem
 	bbdoc: Returns a view of a subset in the #TSet.
 	bbdoc: Returns a view of a subset in the #TSet.
 	returns: A subset view that contains only the values in the specified range.
 	returns: A subset view that contains only the values in the specified range.
-	about: This method returns a view of the range of elements that fall between #lowerValue and #upperValue.
+	about: This method returns a view of the range of elements that fall between @lowerValue and @upperValue.
 	This method does not copy elements from the #TSet, but provides a window into the underlying #TSet itself.
 	This method does not copy elements from the #TSet, but provides a window into the underlying #TSet itself.
 	You can make changes in both the view and in the underlying #TSet.
 	You can make changes in both the view and in the underlying #TSet.
 	End Rem
 	End Rem

+ 2 - 0
maxunit.mod/maxunit.bmx

@@ -586,6 +586,7 @@ Type TAssert
 	
 	
 	Rem
 	Rem
 	bbdoc: Asserts that an #Object is #Null.
 	bbdoc: Asserts that an #Object is #Null.
+	about:
 	If it is not #Null, an #AssertionFailedException is thrown with the given message.
 	If it is not #Null, an #AssertionFailedException is thrown with the given message.
 	End Rem
 	End Rem
 	Function assertNull(obj:Object, message:String = Null)
 	Function assertNull(obj:Object, message:String = Null)
@@ -607,6 +608,7 @@ Type TAssert
 
 
 	Rem
 	Rem
 	bbdoc: Asserts that an pointer is #Null.
 	bbdoc: Asserts that an pointer is #Null.
+	about:
 	If it is not #Null, an #AssertionFailedException is thrown with the given message.
 	If it is not #Null, an #AssertionFailedException is thrown with the given message.
 	End Rem
 	End Rem
 	Function assertNull(value:Byte Ptr, message:String = Null)
 	Function assertNull(value:Byte Ptr, message:String = Null)

+ 1 - 1
stringbuilder.mod/stringbuilder.bmx

@@ -884,7 +884,7 @@ End Type
 Rem
 Rem
 bbdoc: An array of split text from a TStringBuilder.
 bbdoc: An array of split text from a TStringBuilder.
 about: Note that the #TSplitBuffer is only valid while its parent #TStringBuilder is unchanged.
 about: Note that the #TSplitBuffer is only valid while its parent #TStringBuilder is unchanged.
-Once you modify the #TStringBuffer you should call Split() again.
+Once you modify the #TSplitBuffer you should call Split() again.
 End Rem
 End Rem
 Type TSplitBuffer
 Type TSplitBuffer
 Private
 Private