Skip to content

Commit f3fa774

Browse files
author
Robert Righter
committed
documentation
1 parent db08214 commit f3fa774

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,14 @@ Node-xml provides a SAX2 parser interface that can take a string, file.
3131

3232
#Parse#
3333

34-
parser.parseString(string)
34+
##parser.parseString(string)##
3535

3636
Parse an in memory string
3737
* return: boolean. true if no errors, false otherwise
3838
* Arguments
3939
* string - a string representing the document to parse
4040

41-
parser.parseFile(filename)
41+
##parser.parseFile(filename)##
4242

4343
Parse a file
4444
* return: boolean. true if no errors, false otherwise
@@ -47,15 +47,15 @@ Parse a file
4747

4848
#Callbacks#
4949

50-
parser.onStartDocument(function() {})
50+
##parser.onStartDocument(function() {})##
5151

5252
Called at the start of a document
5353

54-
parse.onEndDocument(function() {})
54+
##parse.onEndDocument(function() {})##
5555

5656
Called at the end of the document parse
5757

58-
parser.onStartElementNS(function(elem, attrs, prefix, uri, namespaces) {})
58+
##parser.onStartElementNS(function(elem, attrs, prefix, uri, namespaces) {})##
5959

6060
Called on an open element tag
6161
* Arguments
@@ -65,39 +65,39 @@ Called on an open element tag
6565
* uri - the namespace URI of the element
6666
* namespaces - an array of arrays: [[prefix, uri], [prefix, uri]]
6767

68-
parser.onEndElementNS(function(elem, prefix, uri) {})
68+
##parser.onEndElementNS(function(elem, prefix, uri) {})##
6969

7070
Called at the close of an element
7171
* Arguments
7272
* elem - a string representing the element name
7373
* prefix - a string representing the namespace prefix of the element
7474
* uri - the namespace URI of the element
7575

76-
parser.onCharacters(function(chars) {})
76+
##parser.onCharacters(function(chars) {})##
7777

7878
Called when a set of content characters is encountered
7979
* Arguments
8080
* chars - a string of characters
8181

82-
parser.onCdata(function(cdata) {})
82+
##parser.onCdata(function(cdata) {})##
8383

8484
Called when a CDATA is encountered
8585
* Arguments
8686
* cdata - a string representing the CDATA
8787

88-
parser.onComment(function(msg) {})
88+
##parser.onComment(function(msg) {})##
8989

9090
Called when a comment is encountered
91-
* Arguments
92-
* msg - a string representing the comment
91+
* Arguments
92+
* msg - a string representing the comment
9393

94-
parser.onWarning(function(msg) {})
94+
##parser.onWarning(function(msg) {})##
9595

9696
Called when a warning is encountered
97-
* Arguments
98-
* msg - a string representing the warning message
97+
* Arguments
98+
* msg - a string representing the warning message
9999

100-
parser.onError(function(msg) {})
100+
##parser.onError(function(msg) {})##
101101

102102
Called when an error is encountered
103103
* Arguments

0 commit comments

Comments
 (0)