浏览代码

[php] removed doc blocks from `String` implementation

Alexander Kuzmenko 8 年之前
父节点
当前提交
6a0dce463b
共有 1 个文件被更改,包括 0 次插入123 次删除
  1. 0 123
      std/php/_std/String.hx

+ 0 - 123
std/php/_std/String.hx

@@ -22,167 +22,44 @@
 
 
 import php.*;
 import php.*;
 
 
-/**
-	The basic String class.
-
-	A Haxe String is immutable, it is not possible to modify individual
-	characters. No method of this class changes the state of `this` String.
-
-	Strings can be constructed using the String literal syntax `"string value"`.
-
-	String can be concatenated by using the `+` operator. If an operand is not a
-	String, it is passed through `Std.string()` first.
-
-	@see https://haxe.org/manual/std-String.html
-**/
 @:coreApi extern class String {
 @:coreApi extern class String {
 
 
-	/**
-		The number of characters in `this` String.
-	**/
 	var length(default,null) : Int;
 	var length(default,null) : Int;
 
 
-	/**
-		Creates a copy from a given String.
-	**/
 	@:pure function new(string:String) : Void;
 	@:pure function new(string:String) : Void;
 
 
-	/**
-		Returns a String where all characters of `this` String are upper case.
-
-		Affects the characters `a-z`. Other characters remain unchanged.
-	**/
 	@:pure @:runtime inline function toUpperCase() : String {
 	@:pure @:runtime inline function toUpperCase() : String {
 		return Global.strtoupper(this);
 		return Global.strtoupper(this);
 	}
 	}
 
 
-	/**
-		Returns a String where all characters of `this` String are lower case.
-
-		Affects the characters `A-Z`. Other characters remain unchanged.
-	**/
 	@:pure @:runtime inline function toLowerCase() : String {
 	@:pure @:runtime inline function toLowerCase() : String {
 		return Global.strtolower(this);
 		return Global.strtolower(this);
 	}
 	}
 
 
-	/**
-		Returns the character at position `index` of `this` String.
-
-		If `index` is negative or exceeds `this.length`, the empty String `""`
-		is returned.
-	**/
 	@:pure @:runtime inline function charAt(index : Int) : String {
 	@:pure @:runtime inline function charAt(index : Int) : String {
 		return (index < 0 || index >= this.length ? '' : (this:NativeString)[index]);
 		return (index < 0 || index >= this.length ? '' : (this:NativeString)[index]);
 	}
 	}
 
 
-	/**
-		Returns the character code at position `index` of `this` String.
-
-		If `index` is negative or exceeds `this.length`, `null` is returned.
-
-		To obtain the character code of a single character, `"x".code` can be
-		used instead to @:runtime inline the character code at compile time. Note that
-		this only works on String literals of length 1.
-	**/
 	@:pure @:runtime inline function charCodeAt( index : Int) : Null<Int> {
 	@:pure @:runtime inline function charCodeAt( index : Int) : Null<Int> {
 		return (index < 0 || index >= this.length ? null : Global.ord((this:NativeString)[index]));
 		return (index < 0 || index >= this.length ? null : Global.ord((this:NativeString)[index]));
 	}
 	}
 
 
-	/**
-		Returns the position of the leftmost occurrence of `str` within `this`
-		String.
-
-		If `startIndex` is given, the search is performed within the substring
-		of `this` String starting from `startIndex`. Otherwise the search is
-		performed within `this` String. In either case, the returned position
-		is relative to the beginning of `this` String.
-
-		If `str` cannot be found, -1 is returned.
-	**/
 	@:pure function indexOf( str : String, ?startIndex : Int ) : Int;
 	@:pure function indexOf( str : String, ?startIndex : Int ) : Int;
 
 
-	/**
-		Returns the position of the rightmost occurrence of `str` within `this`
-		String.
-
-		If `startIndex` is given, the search is performed within the substring
-		of `this` String from 0 to `startIndex`. Otherwise the search is
-		performed within `this` String. In either case, the returned position
-		is relative to the beginning of `this` String.
-
-		If `str` cannot be found, -1 is returned.
-	**/
 	@:pure function lastIndexOf( str : String, ?startIndex : Int ) : Int;
 	@:pure function lastIndexOf( str : String, ?startIndex : Int ) : Int;
 
 
-	/**
-		Splits `this` String at each occurrence of `delimiter`.
-
-		If `this` String is the empty String `""`, the result is not consistent
-		across targets and may either be `[]` (on Js, Cpp) or `[""]`.
-
-		If `delimiter` is the empty String `""`, `this` String is split into an
-		Array of `this.length` elements, where the elements correspond to the
-		characters of `this` String.
-
-		If `delimiter` is not found within `this` String, the result is an Array
-		with one element, which equals `this` String.
-
-		If `delimiter` is null, the result is unspecified.
-
-		Otherwise, `this` String is split into parts at each occurrence of
-		`delimiter`. If `this` String starts (or ends) with `delimiter`, the
-		result `Array` contains a leading (or trailing) empty String `""` element.
-		Two subsequent delimiters also result in an empty String `""` element.
-	**/
 	@:pure @:runtime inline function split( delimiter : String ) : Array<String> {
 	@:pure @:runtime inline function split( delimiter : String ) : Array<String> {
 		return @:privateAccess Array.wrap(delimiter == '' ? Global.str_split(this) : Global.explode(delimiter, this));
 		return @:privateAccess Array.wrap(delimiter == '' ? Global.str_split(this) : Global.explode(delimiter, this));
 	}
 	}
 
 
-	/**
-		Returns `len` characters of `this` String, starting at position `pos`.
-
-		If `len` is omitted, all characters from position `pos` to the end of
-		`this` String are included.
-
-		If `pos` is negative, its value is calculated from the end of `this`
-		String by `this.length + pos`. If this yields a negative value, 0 is
-		used instead.
-
-		If the calculated position + `len` exceeds `this.length`, the characters
-		from that position to the end of `this` String are returned.
-
-		If `len` is negative, the result is unspecified.
-	**/
 	@:pure function substr( pos : Int, ?len : Int ) : String;
 	@:pure function substr( pos : Int, ?len : Int ) : String;
 
 
-	/**
-		Returns the part of `this` String from `startIndex` to but not including `endIndex`.
-
-		If `startIndex` or `endIndex` are negative, 0 is used instead.
-
-		If `startIndex` exceeds `endIndex`, they are swapped.
-
-		If the (possibly swapped) `endIndex` is omitted or exceeds
-		`this.length`, `this.length` is used instead.
-
-		If the (possibly swapped) `startIndex` exceeds `this.length`, the empty
-		String `""` is returned.
-	**/
 	@:pure function substring( startIndex : Int, ?endIndex : Int ) : String;
 	@:pure function substring( startIndex : Int, ?endIndex : Int ) : String;
 
 
-	/**
-		Returns the String itself.
-	**/
 	@:pure @:runtime inline function toString() : String {
 	@:pure @:runtime inline function toString() : String {
 		return this;
 		return this;
 	}
 	}
 
 
-	/**
-		Returns the String corresponding to the character code `code`.
-
-		If `code` is negative or has another invalid value, the result is
-		unspecified.
-	**/
 	@:pure @:runtime static inline function fromCharCode( code : Int ) : String {
 	@:pure @:runtime static inline function fromCharCode( code : Int ) : String {
 		return Global.chr(code);
 		return Global.chr(code);
 	}
 	}