mirrors
/
org.aspectj
mirror of https://github.com/eclipse/org.aspectj.git
Watch 1
Star 0
Fork 0
Code Issues 0 Releases 139 Wiki Activity
Browse Source

add some style to our guides ;)

tags/V1_5_0M2
acolyer 19 years ago
parent
e5339af220
commit
d09f86f355
11 changed files with 394 additions and 90 deletions
Split View Show Diff Stats
  1. 123
    86
      docs/adk15ProgGuideDB/annotations.xml
  2. 83
    0
      docs/adk15ProgGuideDB/aspectj-docs.css
  3. BIN
      docs/adk15ProgGuideDB/dd_arrow.gif
  4. 13
    0
      docs/adk15ProgGuideDB/reflection.xml
  5. 5
    1
      docs/build.xml
  6. 83
    0
      docs/devGuideDB/aspectj-docs.css
  7. BIN
      docs/devGuideDB/dd_arrow.gif
  8. 83
    0
      docs/progGuideDB/aspectj-docs.css
  9. BIN
      docs/progGuideDB/dd_arrow.gif
  10. 3
    2
      docs/progGuideDB/semantics.xml
  11. 1
    1
      lib/docbook/docbook-xsl/html/param.xsl

+ 123
- 86
docs/adk15ProgGuideDB/annotations.xml View File

@@ -341,47 +341,65 @@
<para>Some examples of annotation patterns follow:</para>

<programlisting><![CDATA[
@Immutable
]]></programlisting>

<para>Matches any annotated element which has an annotation of
type <literal>Immutable</literal>.</para>

<programlisting><![CDATA[
!@Persistent
]]></programlisting>
<variablelist>

<para>Matches any annotated element which does not have an annotation of
type <literal>Persistent</literal>.</para>
<programlisting><![CDATA[
@Foo @Goo
]]></programlisting>
<para>Matches any annotated element which has both an annotation of type <literal>Foo</literal> and
an annotation of type <literal>Goo</literal>.</para>
<varlistentry>
<term>@Immutable</term>
<listitem>
<para>
Matches any annotated element which has an annotation of
type <literal>Immutable</literal>.
</para>
</listitem>
</varlistentry>

<programlisting><![CDATA[
@(Foo || Goo)
]]></programlisting>
<varlistentry>
<term>!@Persistent</term>
<listitem>
<para>
Matches any annotated element which does not have an annotation of
type <literal>Persistent</literal>.
</para>
</listitem>
</varlistentry>

<para>Matches any annotated element which has either an annotation of a type matching
the type pattern <literal>(Foo || Goo)</literal>.
In other words, an annotated element with either an
annotation of type <literal>Foo</literal> or
an annotation of type <literal>Goo</literal> (or both). (The parenthesis are required in this example).
</para>
<varlistentry>
<term>@Foo @Goo</term>
<listitem>
<para>
Matches any annotated element which has both an annotation of type <literal>Foo</literal> and
an annotation of type <literal>Goo</literal>.
</para>
</listitem>
</varlistentry>

<programlisting><![CDATA[
@(org.xyz..*)
]]></programlisting>
<varlistentry>
<term>@(Foo || Goo)</term>
<listitem>
<para>
Matches any annotated element which has either an annotation of a type matching
the type pattern <literal>(Foo || Goo)</literal>.
In other words, an annotated element with either an
annotation of type <literal>Foo</literal> or
an annotation of type <literal>Goo</literal> (or both). (The parenthesis are required in this example).
</para>
</listitem>
</varlistentry>

<para>Matches any annotated element which has either an annotation of a type matching
the type pattern <literal>(org.xyz..*)</literal>.
In other words, an annotated element with an annotation that is declared in the
org.xyz package or a sub-package. (The parenthesis are required in this example).</para>
<varlistentry>
<term>@(org.xyz..*)</term>
<listitem>
<para>
Matches any annotated element which has either an annotation of a type matching
the type pattern <literal>(org.xyz..*)</literal>.
In other words, an annotated element with an annotation that is declared in the
org.xyz package or a sub-package. (The parenthesis are required in this example).
</para>
</listitem>
</varlistentry>

</variablelist>
</sect2>
<sect2>
@@ -425,64 +443,83 @@
patterns:
</para>

<programlisting><![CDATA[
(@Immutable *)
]]></programlisting>
<variablelist>

<para>Matches any type with an <literal>@Immutable</literal> annotation.</para>
<varlistentry>
<term>(@Immutable *)</term>
<listitem>
<para>
Matches any type with an <literal>@Immutable</literal> annotation.
</para>
</listitem>
</varlistentry>

<programlisting><![CDATA[
(!@Immutable *)
]]></programlisting>
<varlistentry>
<term>(!@Immutable *)</term>
<listitem>
<para>
Matches any type which does not have an <literal>@Immutable</literal> annotation.
</para>
</listitem>
</varlistentry>

<para>Matches any type which does not have an <literal>@Immutable</literal> annotation.</para>
<varlistentry>
<term> (@Immutable (org.xyz.* || org.abc.*))</term>
<listitem>
<para>
Matches any type in the <literal>org.xyz</literal> or <literal>org.abc</literal>
packages with the <literal>@Immutable</literal> annotation.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>((@Immutable Foo+) || Goo)</term>
<listitem>
<para>
Matches a type <literal>Foo</literal> or any of its subtypes, which have the <literal>@Immutable</literal>
annotation, or a type <literal>Goo</literal>.
</para>
</listitem>
</varlistentry>

<programlisting><![CDATA[
(@Immutable (org.xyz.* || org.abc.*))
]]></programlisting>
<varlistentry>
<term>((@(Immutable || NonPersistent) org.xyz..*)</term>
<listitem>
<para>
Matches any type in a package beginning with the prefix <literal>org.xyz</literal>,
which has either the <literal>@Immutable</literal> annotation or the
<literal>@NonPersistent</literal> annotation.
</para>
</listitem>
</varlistentry>

<para>Matches any type in the <literal>org.xyz</literal> or <literal>org.abc</literal>
packages with the <literal>@Immutable</literal> annotation.</para>
<varlistentry>
<term>(@Immutable @NonPersistent org.xyz..*)</term>
<listitem>
<para>
Matches any type in a package beginning with the prefix <literal>org.xyz</literal>,
which has both an <literal>@Immutable</literal> annotation and an
<literal>@NonPersistent</literal> annotation.
</para>
</listitem>
</varlistentry>

<programlisting><![CDATA[
((@Immutable Foo+) || Goo)
]]></programlisting>
<varlistentry>
<term> (@(@Inherited *) org.xyz..*)</term>
<listitem>
<para>
Matches any type in a package beginning with the prefix <literal>org.xyz</literal>,
which has an inheritable annotation. The annotation pattern
<literal>@(@Inherited *)</literal> matches any annotation of a type matching the
type pattern <literal>@Inherited *</literal>, which in turn matches any type with the
<literal>@Inherited</literal> annotation.
</para>
</listitem>
</varlistentry>

<para>Matches a type <literal>Foo</literal> or any of its subtypes, which have the <literal>@Immutable</literal>
annotation, or a type <literal>Goo</literal>.</para>
<programlisting><![CDATA[
((@(Immutable || NonPersistent) org.xyz..*)
]]></programlisting>

<para>
Matches any type in a package beginning with the prefix <literal>org.xyz</literal>,
which has either the <literal>@Immutable</literal> annotation or the
<literal>@NonPersistent</literal> annotation.
</para>

<programlisting><![CDATA[
(@Immutable @NonPersistent org.xyz..*)
]]></programlisting>

<para>
Matches any type in a package beginning with the prefix <literal>org.xyz</literal>,
which has both an <literal>@Immutable</literal> annotation and an
<literal>@NonPersistent</literal> annotation.
</para>
<programlisting><![CDATA[
(@(@Inherited *) org.xyz..*)
]]></programlisting>

<para>
Matches any type in a package beginning with the prefix <literal>org.xyz</literal>,
which has an inheritable annotation. The annotation pattern
<literal>@(@Inherited *)</literal> matches any annotation of a type matching the
type pattern <literal>@Inherited *</literal>, which in turn matches any type with the
<literal>@Inherited</literal> annotation.
</para>
</variablelist>
</sect2>
<sect2 id="signaturePatterns" xreflabel="Signature Patterns">

+ 83
- 0
docs/adk15ProgGuideDB/aspectj-docs.css View File

@@ -0,0 +1,83 @@
body {
font-family: "Lucida Grande", "Trebuchet MS", sans-serif;
line-height: 1.1em;
}

h2 {
font-size: 130%;
font-weight: bold ;
line-height: 16px;
color: #FFFFFF;
background-color: #0080C0;
padding: 5px;
}

h3 {
font-size: 110%;
font-weight: bold ;
line-height: 14px;
color: #FFFFFF;
background-color: orange;
padding: 5px;
}

tt {
font-size: 120%;
color: #0080C0;
}

tt tt {
font-size: 100%;
}

.programlisting {
padding-top: 5px;
border: 2px solid #ccc;
background: #eee;
font-size: 120%;
color: #111199;

}

.term {
color: #111199;
}

.variablelist dd {
margin-left: 18px;
padding-left: 20px;
background: url(dd_arrow.gif) no-repeat 0 2px;
}

.toc dt {
font-size: 110%;
padding-bottom: 0px;
margin-bottom: 5px;
}

.toc dl dd dt {
font-size: 100%;
}

.toc dt {
font-size: 100%
margin-bottom: 0;
}

.informaltable table {
margin-left: 5%;
}

.informaltable th {
background-color: orange;
padding: 1px;
}

ul li {
line-height: 1.2em;
}

.keyword {
font-weight: bold;
color: purple;
}

BIN
docs/adk15ProgGuideDB/dd_arrow.gif View File


+ 13
- 0
docs/adk15ProgGuideDB/reflection.xml View File

@@ -2,5 +2,18 @@

<title>New Reflection Interfaces</title>
<para>
AspectJ 5 provides support for runtime reflection of aspect types. The class <literal>Aspect</literal> is
analogous to the Java class <literal>Class</literal> and provides access to the members of an aspect.
</para>
<sect1 id="reflection_api">
<title>The Aspect Class</title>
<para>
</para>
</sect1>
</chapter>


+ 5
- 1
docs/build.xml View File

@@ -269,6 +269,8 @@
<antcall target="build-guide">
<param name="guide.dir" value="progGuideDB" />
<param name="guide.name" value="progguide" />
<param name="xml-html-copy"
value="dd_arrow.gif,aspects.gif,figureUML.gif,overview.gif,telecom.gif,aspectj-docs.css"/>
</antcall>
</target>

@@ -276,6 +278,8 @@
<antcall target="build-guide">
<param name="guide.dir" value="adk15ProgGuideDB" />
<param name="guide.name" value="adk15notebook" />
<param name="xml-html-copy"
value="dd_arrow.gif,aspectj-docs.css"/>
</antcall>
</target>

@@ -298,7 +302,7 @@

<antcall target="build-guide">
<param name="xml-html-copy"
value="ajbrowser-building.gif,ajbrowser-options.gif,${include.devguide.icons}"
value="dd_arrow.gif,aspectj-docs.css,ajbrowser-building.gif,ajbrowser-options.gif,${include.devguide.icons}"
/>
<param name="guide.dir" value="devGuideDB" />
<param name="guide.name" value="devguide" />

+ 83
- 0
docs/devGuideDB/aspectj-docs.css View File

@@ -0,0 +1,83 @@
body {
font-family: "Lucida Grande", "Trebuchet MS", sans-serif;
line-height: 1.1em;
}

h2 {
font-size: 130%;
font-weight: bold ;
line-height: 16px;
color: #FFFFFF;
background-color: #0080C0;
padding: 5px;
}

h3 {
font-size: 110%;
font-weight: bold ;
line-height: 14px;
color: #FFFFFF;
background-color: orange;
padding: 5px;
}

tt {
font-size: 120%;
color: #0080C0;
}

tt tt {
font-size: 100%;
}

.programlisting {
padding-top: 5px;
border: 2px solid #ccc;
background: #eee;
font-size: 120%;
color: #111199;

}

.term {
color: #111199;
}

.variablelist dd {
margin-left: 18px;
padding-left: 20px;
background: url(dd_arrow.gif) no-repeat 0 2px;
}

.toc dt {
font-size: 110%;
padding-bottom: 0px;
margin-bottom: 5px;
}

.toc dl dd dt {
font-size: 100%;
}

.toc dt {
font-size: 100%
margin-bottom: 0;
}

.informaltable table {
margin-left: 5%;
}

.informaltable th {
background-color: orange;
padding: 1px;
}

ul li {
line-height: 1.2em;
}

.keyword {
font-weight: bold;
color: purple;
}

BIN
docs/devGuideDB/dd_arrow.gif View File


+ 83
- 0
docs/progGuideDB/aspectj-docs.css View File

@@ -0,0 +1,83 @@
body {
font-family: "Lucida Grande", "Trebuchet MS", sans-serif;
line-height: 1.1em;
}

h2 {
font-size: 130%;
font-weight: bold ;
line-height: 16px;
color: #FFFFFF;
background-color: #0080C0;
padding: 5px;
}

h3 {
font-size: 110%;
font-weight: bold ;
line-height: 14px;
color: #FFFFFF;
background-color: orange;
padding: 5px;
}

tt {
font-size: 120%;
color: #0080C0;
}

tt tt {
font-size: 100%;
}

.programlisting {
padding-top: 5px;
border: 2px solid #ccc;
background: #eee;
font-size: 120%;
color: #111199;

}

.term {
color: #111199;
}

.variablelist dd {
margin-left: 18px;
padding-left: 20px;
background: url(dd_arrow.gif) no-repeat 0 2px;
}

.toc dt {
font-size: 110%;
padding-bottom: 0px;
margin-bottom: 5px;
}

.toc dl dd dt {
font-size: 100%;
}

.toc dt {
font-size: 100%
margin-bottom: 0;
}

.informaltable table {
margin-left: 5%;
}

.informaltable th {
background-color: orange;
padding: 1px;
}

ul li {
line-height: 1.2em;
}

.keyword {
font-weight: bold;
color: purple;
}

BIN
docs/progGuideDB/dd_arrow.gif View File


+ 3
- 2
docs/progGuideDB/semantics.xml View File

@@ -209,14 +209,15 @@

<informaltable frame="1">
<tgroup cols="4" align="left">
<tbody valign="top">
<thead valign="top">
<row>
<entry><emphasis role="bold">Join Point</emphasis></entry>
<entry><emphasis role="bold">Current Object</emphasis></entry>
<entry><emphasis role="bold">Target Object</emphasis></entry>
<entry><emphasis role="bold">Arguments</emphasis></entry>
</row>

</thead>
<tbody>
<row>
<entry>Method Call</entry>
<entry>executing object*</entry>

+ 1
- 1
lib/docbook/docbook-xsl/html/param.xsl View File

@@ -86,7 +86,7 @@ is suppressed.
</doc:param>
<!-- ==================================================================== -->
<xsl:param name="html.stylesheet" select="''" doc:type='string'/>
<xsl:param name="html.stylesheet" doc:type='string'>aspectj-docs.css</xsl:param>
<doc:param name="html.stylesheet" xmlns="">
<refpurpose>Name of the stylesheet to use in the generated HTML</refpurpose>

Write Preview
Loading…
Cancel
Save