remove docs for python/_std/Ereg

std/python/_std/EReg.hx

@@ -26,15 +26,6 @@ import python.lib.Re.Pattern;
 
 @:coreApi
 class EReg {
-
-	/**
-		Creates a new regular expression with pattern `r` and modifiers `opt`.
-
-		This is equivalent to the shorthand syntax `~/r/opt`
-
-		If `r` or `opt` are null, the result is unspecified.
-	**/
-
 	var pattern:Regex;
 	var matchObj:MatchObject;
 	var global:Bool;
@@ -53,89 +44,27 @@ class EReg {
 		pattern = Re.compile(r, options);
 	}
 
-	/**
-		Tells if `this` regular expression matches String `s`.
-
-		This method modifies the internal state.
-
-		If `s` is `null`, the result is unspecified.
-	**/
 	public inline function match( s : String ) : Bool {
 		matchObj = Re.search(pattern, s);
 		return matchObj != null;
 	}
 
-	/**
-		Returns the matched sub-group `n` of `this` EReg.
-
-		This method should only be called after `this.match` or
-		`this.matchSub`, and then operates on the String of that operation.
-
-		The index `n` corresponds to the n-th set of parentheses in the pattern
-		of `this` EReg. If no such sub-group exists, an exception is thrown.
-
-		If `n` equals 0, the whole matched substring is returned.
-	**/
 	public inline function matched( n : Int ) : String {
 		return matchObj.group(n);
 	}
 
-	/**
-		Returns the part to the left of the last matched substring.
-
-		If the most recent call to `this.match` or `this.matchSub` did not
-		match anything, the result is unspecified.
-
-		If the global g modifier was in place for the matching, only the
-		substring to the left of the leftmost match is returned.
-
-		The result does not include the matched part.
-	**/
 	public inline function matchedLeft() : String {
 		return matchObj.string.substr(0, matchObj.start());
 	}
 
-	/**
-		Returns the part to the right of the last matched substring.
-
-		If the most recent call to `this.match` or `this.matchSub` did not
-		match anything, the result is unspecified.
-
-		If the global g modifier was in place for the matching, only the
-		substring to the right of the leftmost match is returned.
-
-		The result does not include the matched part.
-	**/
 	public inline function matchedRight() : String {
 		return matchObj.string.substr(matchObj.end());
 	}
 
-	/**
-		Returns the position and length of the last matched substring, within
-		the String which was last used as argument to `this.match` or
-		`this.matchSub`.
-
-		If the most recent call to `this.match` or `this.matchSub` did not
-		match anything, the result is unspecified.
-
-		If the global g modifier was in place for the matching, the position and
-		length of the leftmost substring is returned.
-	**/
 	public inline function matchedPos() : { pos : Int, len : Int } {
 		return { pos : matchObj.start(), len : matchObj.end() - matchObj.start() };
 	}
 
-	/**
-		Tells if `this` regular expression matches a substring of String `s`.
-
-		This function expects `pos` and `len` to describe a valid substring of
-		`s`, or else the result is unspecified. To get more robust behavior,
-		`this.matchSub(s.substr(pos,len))` can be used instead.
-
-		This method modifies the internal state.
-
-		If `s` is null, the result is unspecified.
-	**/
 	public function matchSub( s : String, pos : Int, len : Int = -1):Bool {
 		if (len != -1) {
 			matchObj = pattern.search(s, pos, pos+len);
@@ -147,24 +76,6 @@ class EReg {
 
 	}
 
-	/**
-		Splits String `s` at all substrings `this` EReg matches.
-
-		If a match is found at the start of `s`, the result contains a leading
-		empty String "" entry.
-
-		If a match is found at the end of `s`, the result contains a trailing
-		empty String "" entry.
-
-		If two matching substrings appear next to each other, the result
-		contains the empty String "" between them.
-
-		By default, this method splits `s` into two parts at the first matched
-		substring. If the global g modifier is in place, `s` is split at each
-		matched substring.
-
-		If `s` is null, the result is unspecified.
-	**/
 	public function split( s : String ) : Array<String> {
 		return if (global) {
 			var ret = [];
@@ -188,20 +99,6 @@ class EReg {
 		}
 	}
 
-	/**
-		Replaces the first substring of `s` which `this` EReg matches with `by`.
-
-		If `this` EReg does not match any substring, the result is `s`.
-
-		By default, this method replaces only the first matched substring. If
-		the global g modifier is in place, all matched substrings are replaced.
-
-		If `by` contains `$1` to `$9`, the digit corresponds to number of a
-		matched sub-group and its value is used instead. If no such sub-group
-		exists, the replacement is unspecified. The string `$$` becomes `$`.
-
-		If `s` or `by` are null, the result is unspecified.
-	**/
 	public function replace( s : String, by : String ) : String
 	{
 		var by = by.split("$$").join("_hx_#repl#__");
@@ -218,11 +115,6 @@ class EReg {
 		return Re.sub(pattern, replace, s, global ? 0 : 1 );
 	}
 
-	/**
-		For each occurence of the pattern in the string `s`, the function `f` is called and
-		can return the string that needs to be replaced. All occurences are matched anyway,
-		and setting the `g` flag might cause some incorrect behavior on some platforms.
-	**/
 	public function map( s : String, f : EReg -> String ) : String {
 
 		var buf = new StringBuf();
@@ -274,4 +166,4 @@ class EReg {
 		return buf.toString();
 
 	}
-}
+}