examples/javadoc

Stylesheet javadocstyle.xsl

examples/javadoc/javadocstyle.xsl

comment for stylesheet is the first comment in the file

"quots" too?

<p> USES HTML AND @tag COMMENTS! </p> <p> THIS FILE DOES NOT WORK - ONLY SHOWS HOW TO DOCUMENT </p> <p> builds a simplified xml file of a given xsl stylesheet with only the needed information for xsldoc. add here if you need to comment more elements. </p> <p>elements that are transformed are (all in the standard xslt namespace http://www.w3.org/1999/XSL/Transform)</p> <ul>

System Message: ERROR/3 (<string>, line 17)

Unexpected indentation.
<li>xsl:stylesheet or xsl:transform</li> <li>xsl:output</li> <li>xsl:param</li> <li>xsl:include</li> <li>xsl:import</li> <li>xsl:variable</li> <li>xsl:template</li>

System Message: WARNING/2 (<string>, line 24)

Block quote ends without a blank line; unexpected unindent.

</ul> <p>all comments that are directly <b>in front of</b> an element are tranformed to a comment-element <b>except</b> for the opening xsl:stylesheet element for which the <b>first following comment</b> is used.</p>

System Message: ERROR/3 (<string>, line 28)

Unexpected indentation.
<p>non ASCII characters should work in comments (öäüÜÖÄß), pyxsldoc normally assumes

System Message: WARNING/2 (<string>, line 29)

Block quote ends without a blank line; unexpected unindent.
UTF-8 documents</p>
@author Christof Hoeke @version 0.43 040524
Stylesheet javadocstyle.xsl

XSLT version 1.0

imports test1.xsl, test2.xsl

includes testa.xsl, testb.xsl, testc.xsl

namespace-alias
  • stylesheet-prefix test="test", result-prefix xsl="http://www.w3.org/1999/XSL/Transform"
output
  • encoding="UTF-8"
  • indent="yes"
  • method="xml"
  • omit-xml-declaration="yes"
  • standalone="no"

preserve-space for elements "some"

strip-space for elements "test | test2"

Param Summary
par1 - default value: 1
comment for param 1
par2 - default value: 2
comment for param 2
Variable Summary
var1 = 1
comment for variable var 1
var2 = 2
comment for variable var 2
var3 = 3
comment for variable var 3
Decimal Format Summary
name1
comment for decimal formatter1
name2
comment for decimal formatter2
Key Summary
n
comment for key 1
n2
comment for key 2
Attribute Set Summary
as1
comment for this attribute set
as2
Template Summary
/xsl:stylesheet | /xsl:transform
all stylesheets start with these root elements. all attributes are processed.
bug_1(test1, test2, test3)
insert-comment(test1, test2) mode="mode3"
inserts the comment as a comment-element for the calling element as a normalized-space value
mall mode="mode12" priority="2"
match template with everything
melement
match template without params, mode, priority
mnall mode="mode1" priority="5"
nmall(t1, t2, t3)
match and named template with everything
mnelement
nmelement()
match/named template without params, mode, priority
mnpelement priority="1"
nmpelement()
match/named template without params, mode
mnpmelement mode="m1" priority="1"
nmpmelement()
match/named template without params
mpelement priority="1"
match template without params, mode
mpmelement mode="m1" priority="1"
match template without params
nall(t1, t2, t3) mode="x" priority="3"
named template with everything
nelement()
named template without params, mode, priority
npelement() priority="1"
named template without params, mode
npmelement() mode="m1" priority="1"
named template without params
sorted()
test if sorted right in summary
sorted
test if sorted right in summary
sorted mode="1"
test if sorted right in summary
sorted mode="2"
test if sorted right in summary
sorted() mode="2"
test if sorted right in summary
sorted mode="1" priority="1"
test if sorted right in summary
sorted mode="5" priority="1"
test if sorted right in summary
sorted priority="3"
test if sorted right in summary
sorted priority="5"
test if sorted right in summary
sorted mode="5" priority="6"
test if sorted right in summary
xsl:include | xsl:import
the attributes name and href are processed
xsl:output
all attributes are processed
xsl:param | xsl:variable
param and variable, select will be processed. content will be just copied!
xsl:template
match and name attributes and all param elements are processed

Param Detail

par1

default value: 1

comment for param 1

par2

default value: 2

comment for param 2

Variable Detail

var2

var2 = 2

comment for variable var 2

var3

var3 = 3

comment for variable var 3

var1

var1 = 1

comment for variable var 1

Decimal Format Detail

name2

NaN NaN
decimal-separator .
name name2
pattern-separator ;
per-mille
percent %
zero-digit 0

comment for decimal formatter2

name1

NaN NaN
decimal-separator ,
digit #
grouping-separator .
infinity Inf
minus-sign -
name name1
pattern-separator ;
per-mille
percent %
zero-digit 0

comment for decimal formatter1

Key Detail

n2

matches: m2
uses: u2

comment for key 2

n

matches: m
uses: u

comment for key 1

Attribute Set Detail

as1

  • a1=x
  • a2=

comment for this attribute set

as2

  • a1=x
  • a2=y

Template Detail

sorted

matches: "sorted"
mode: "1"

test if sorted right in summary

sorted

matches: "sorted"
mode: "2"

test if sorted right in summary

sorted()

name: "sorted"

test if sorted right in summary

sorted

matches: "sorted"

test if sorted right in summary

sorted

matches: "sorted"
priority: "5"

test if sorted right in summary

sorted

matches: "sorted"
mode: "5"
priority: "1"

test if sorted right in summary

sorted()

name: "sorted"
mode: "2"

test if sorted right in summary

sorted

matches: "sorted"
mode: "1"
priority: "1"

test if sorted right in summary

sorted

matches: "sorted"
mode: "5"
priority: "6"

test if sorted right in summary

sorted

matches: "sorted"
priority: "3"

test if sorted right in summary

melement

matches: "melement"

match template without params, mode, priority

does nothing

nelement()

name: "nelement"

named template without params, mode, priority

does nothing

mnelement
nmelement()

matches: "mnelement"
name: "nmelement"

match/named template without params, mode, priority

does nothing

mpelement

matches: "mpelement"
priority: "1"

match template without params, mode

does nothing

npelement()

name: "npelement"
priority: "1"

named template without params, mode

does nothing

mnpelement
nmpelement()

matches: "mnpelement"
name: "nmpelement"
priority: "1"

match/named template without params, mode

does nothing

mpmelement

matches: "mpmelement"
mode: "m1"
priority: "1"

match template without params

does nothing

npmelement()

name: "npmelement"
mode: "m1"
priority: "1"

named template without params

does nothing

mnpmelement
nmpmelement()

matches: "mnpmelement"
name: "nmpmelement"
mode: "m1"
priority: "1"

match/named template without params

does nothing

mall

matches: "mall"
mode: "mode12"
priority: "2"

match template with everything

does nothing

parameters
  • t1
    default value: default in content
  • t2
    default value: default in select
  • t3

    no default

nall(t1, t2, t3)

name: "nall"
mode: "x"
priority: "3"

named template with everything

does nothing

parameters
  • t1
    default value: default in content
  • t2
    default value: default in select
  • t3

    no default

mnall
nmall(t1, t2, t3)

matches: "mnall"
name: "nmall"
mode: "mode1"
priority: "5"

match and named template with everything

does nothing

parameters
  • t1
    default value: default in content
  • t2
    default value: default in select
  • t3

    no default

/xsl:stylesheet | /xsl:transform

matches: "/xsl:stylesheet | /xsl:transform"

all stylesheets start with these root elements. all attributes are processed.

xsl:include | xsl:import

matches: "xsl:include | xsl:import"

the attributes name and href are processed

xsl:output

matches: "xsl:output"

all attributes are processed

xsl:param | xsl:variable

matches: "xsl:param | xsl:variable"

param and variable, select will be processed. content will be just copied!

xsl:template

matches: "xsl:template"

match and name attributes and all param elements are processed

insert-comment(test1, test2)

name: "insert-comment"
mode: "mode3"

inserts the comment as a comment-element for the calling element as a normalized-space value

parameters
  • test1
    default value: 1
  • test2
    default value: 2

bug_1(test1, test2, test3)

name: "bug_1"

Comment for <b>bug_1</b>
@author Doron Enav @version 0.65

System Message: WARNING/2 (<string>, line 4)

Block quote ends without a blank line; unexpected unindent.

@param test1 Javadoc param comment for test1 @param test2 Javadoc param comment for test2

parameters
  • test1
    default value: 1

    comment test 1 before test 1

  • test2
    default value: 2

    comment test 2 before test 2

  • test3

    comment test 3 before test 3

bottom.txt file - shown below the bottom navigation

TEST (äöü߀) < > &