Changes between Version 12 and Version 13 of PyYAMLDocumentation

Timestamp:

05/07/06 02:51:19 (7 years ago)

Author:

xi

Comment:

--

PyYAMLDocumentation

@@ -981 +981 @@
 }}}
 
+The function '''`scan(stream)`''' scans the given `stream` and produces a sequence of tokens.
+
+The method '''`Loader.check_token(*TokenClasses)`''' returns `True` if the next token in the stream
+is an instance of one of the given `TokenClasses`. Otherwise it returns `False`.
+
+The method '''`Loader.peek_token()`''' returns the next token in the stream, but does not remove
+it from the internal token queue. The function returns `None` at the end of the stream.
+
+The method '''`Loader.get_token()`''' returns the next token in the stream and removes
+it from the internal token queue. The function returns `None` at the end of the stream.
+
 
 ==== Parser interface ====
+
+{{{
+#!python
+parse(stream, Loader=Loader)
+
+Loader.check_event(*EventClasses)
+Loader.peek_event()
+Loader.get_event()
+}}}
+
+The function '''`parse(stream)`''' parses the given `stream` and produces a sequence of parsing events.
+
+The method '''`Loader.check_event(*EventClasses)`''' returns `True` if the next event in the stream
+is an instance of one of the given `EventClasses`. Otherwise it returns `False`.
+
+The method '''`Loader.peek_event()`''' returns the next event in the stream, but does not remove
+it from the internal event queue. The function returns `None` at the end of the stream.
+
+The method '''`Loader.get_event()`''' returns the next event in the stream and removes
+it from the internal event queue. The function returns `None` at the end of the stream.