examples/javadoc

Stylesheet javadocstyle.xsl

examples/javadoc/javadocstyle.xsl

comment for stylesheet is the first comment in the file "quots" too?

USES HTML AND tag COMMENTS!

THIS FILE DOES NOT WORK - ONLY SHOWS HOW TO DOCUMENT

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.

elements that are transformed are (all in the standard xslt namespace http://www.w3.org/1999/XSL/Transform)

  • xsl:stylesheet or xsl:transform
  • xsl:output
  • xsl:param
  • xsl:include
  • xsl:import
  • xsl:variable
  • xsl:template

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

non ASCII characters should work in comments (öäüÜÖÄß), pyxsldoc normally assumes UTF-8 documents

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
par2 - default value: 2
Variable Summary
var1 = 1
var2 = 2
var3 = 3
Decimal Format Summary
name1
name2
Key Summary
n
n2
Attribute Set Summary
as1
as2
Template Summary
/xsl:stylesheet | /xsl:transform
bug_1(test1, test2, test3)
insert-comment(test1, test2) mode="mode3"
mall mode="mode12" priority="2"
melement
mnall mode="mode1" priority="5"
nmall(t1, t2, t3)
mnelement
nmelement()
mnpelement priority="1"
nmpelement()
mnpmelement mode="m1" priority="1"
nmpmelement()
mpelement priority="1"
mpmelement mode="m1" priority="1"
nall(t1, t2, t3) mode="x" priority="3"
nelement()
npelement() priority="1"
npmelement() mode="m1" priority="1"
sorted()
sorted
sorted mode="1"
sorted mode="2"
sorted() mode="2"
sorted mode="1" priority="1"
sorted mode="5" priority="1"
sorted priority="3"
sorted priority="5"
sorted mode="5" priority="6"
xsl:include | xsl:import
xsl:output
xsl:param | xsl:variable
xsl:template

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 bug_1

Author:

Doron Enav

Version:

0.65

parameters
  • test1
    default value: 1
    Javadoc param comment for test1
  • test2
    default value: 2
    Javadoc param comment for test2
  • test3

    comment test 3 before test 3

bottom.txt file - shown below the bottom navigation

TEST (äöü߀) < > &