Skip to content

Commit fe6933b

Browse files
michelouadriaanm
michelou
authored andcommitted
improved handling of scaladoc comments
1 parent 61acd25 commit fe6933b

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

src/library/scala/xml/Node.scala

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,8 @@ abstract class Node extends NodeSeq {
4444
/** label of this node. I.e. "foo" for <foo/>) */
4545
def label: String
4646

47-
/** used internally. Atom/Molecule = -1 PI = -2 Comment = -3 EntityRef = -5 */
47+
/** used internally. Atom/Molecule = -1 PI = -2 Comment = -3 EntityRef = -5
48+
*/
4849
def typeTag$: Int = 0
4950

5051
/**
@@ -54,22 +55,23 @@ abstract class Node extends NodeSeq {
5455
def scope: NamespaceBinding = TopScope
5556

5657
/**
57-
* convenience, same as getNamespace(this.prefix)
58+
* convenience, same as <code>getNamespace(this.prefix)</code>
5859
*/
5960
def namespace = getNamespace(this.prefix)
6061

6162
/**
6263
* Convenience method, same as <code>scope.getURI(pre)</code> but additionally
6364
* checks if scope is <code>null</code>.
6465
*
65-
* @param pre the prefix whose namespace name we would like to obtain
66-
* @return the namespace if scope != null and prefix was found, else null
66+
* @param pre the prefix whose namespace name we would like to obtain
67+
* @return the namespace if <code>scope != null</code> and prefix was
68+
* found, else <code>null</code>
6769
*/
6870
def getNamespace(pre: String) = if (scope == null) null else scope.getURI(pre)
6971

7072
/**
7173
* Convenience method, looks up an unprefixed attribute in attributes of this node.
72-
* Same as attributes.getValue(key);
74+
* Same as <code>attributes.getValue(key)</code>
7375
*
7476
* @param key of queried attribute.
7577
* @return value of <code>UnprefixedAttribute</code> with given key
@@ -79,7 +81,7 @@ abstract class Node extends NodeSeq {
7981

8082
/**
8183
* Convenience method, looks up a prefixed attribute in attributes of this node.
82-
* Same as attributes.getValue(uri, this, key);
84+
* Same as <code>attributes.getValue(uri, this, key)</code>
8385
*
8486
* @param uri namespace of queried attribute (may not be null).
8587
* @param key of queried attribute.
@@ -121,7 +123,7 @@ abstract class Node extends NodeSeq {
121123
* label, attributes and children.
122124
*
123125
* @param x ...
124-
* @return ...
126+
* @return <code>true</code> if ..
125127
*/
126128
override def equals(x: Any): Boolean = x match {
127129
case g:Group => false
@@ -144,7 +146,7 @@ abstract class Node extends NodeSeq {
144146
/**
145147
* returns a sequence consisting of only this node
146148
*/
147-
def theSeq:Seq[Node] = this :: Nil
149+
def theSeq: Seq[Node] = this :: Nil
148150

149151
/**
150152
* String representation of this node
@@ -158,7 +160,7 @@ abstract class Node extends NodeSeq {
158160
/**
159161
* Same as <code>toString(false)</code>.
160162
*
161-
* @see "toString(Boolean)"
163+
* @see <code><a href="#toString">toString(Boolean)</a></code>
162164
*/
163165
override def toString(): String = toString(false)
164166

0 commit comments

Comments
 (0)