Update reference documentation generation tools to get source highlighting [SPRNET-1045]

This commit is contained in:
bbaia
2008-10-05 17:25:10 +00:00
parent 26cb75d4e0
commit 5dfa039603
125 changed files with 4487 additions and 7338 deletions

View File

@@ -1,4 +1,22 @@
<chapter id="misc">
<?xml version="1.0" encoding="utf-8"?>
<!--
/*
* Copyright 2002-2008 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-->
<chapter xml:id="misc" xmlns="http://docbook.org/ns/docbook" version="5">
<title>Spring.NET miscellanea</title>
<sect1>
<title>Introduction</title>
@@ -23,12 +41,10 @@
features.
</para>
<para>To do the match, you use the method:
<programlisting format='linespecific' xml:space='preserve'>
tatic bool Match(string pattern, string path)</programlisting>
<programlisting language="csharp">static bool Match(string pattern, string path)</programlisting>
</para>
<para>If you want to decide if case is important or not use the method:
<programlisting format='linespecific' xml:space='preserve'>
tatic bool Match(string pattern, string path, bool ignoreCase)</programlisting>
<programlisting language="csharp">static bool Match(string pattern, string path, bool ignoreCase)</programlisting>
</para>
<sect2>
<title>General rules</title>
@@ -60,35 +76,29 @@ tatic bool Match(string pattern, string path, bool ignoreCase)</programlisting>
<para>
A file name can be matched using the following
notation:
<programlisting format='linespecific' xml:space='preserve'>
foo?bar.*</programlisting>
<programlisting>foo?bar.*</programlisting>
matches:
<programlisting format='linespecific' xml:space='preserve'>
fooAbar.txt
<programlisting>fooAbar.txt
foo1bar.txt
foo_bar.txt
foo-bar.txt</programlisting>
does not match:
<programlisting format='linespecific' xml:space='preserve'>
foo.bar.txt
<programlisting>foo.bar.txt
foo/bar.txt
foo\bar.txt</programlisting>
</para>
<para>
The classical all files pattern:
<programlisting format='linespecific' xml:space='preserve'>
*.*</programlisting>
<programlisting>*.*</programlisting>
matches:
<programlisting format='linespecific' xml:space='preserve'>
foo.db
<programlisting>foo.db
.db
foo
foo.bar.db
foo.db.db
db.db.db</programlisting>
does not match:
<programlisting format='linespecific' xml:space='preserve'>
c:/
<programlisting>c:/
c:/foo.db
c:/foo
c:/.db
@@ -102,48 +112,39 @@ c:/foo.foo.db
<para>
A directory name can be matched at any depth level using the following
notation:
<programlisting format='linespecific' xml:space='preserve'>
**/db/**</programlisting>
<programlisting>**/db/**</programlisting>
That pattern matches the following paths:
<programlisting format='linespecific' xml:space='preserve'>
/db
<programlisting>/db
//server/db
c:/db
c:/spring/app/db/foo.db
//Program Files/App/spaced dir/db/foo.db
/home/spring/spaced dir/db/v1/foo.db</programlisting>
but does not match these:
<programlisting format='linespecific' xml:space='preserve'>
c:/spring/app/db-v1/foo.db
<programlisting>c:/spring/app/db-v1/foo.db
/home/spring/spaced dir/db-v1/foo.db</programlisting>
</para>
<para>
You can compose subdirectories to match like this:
<programlisting format='linespecific' xml:space='preserve'>
**/bin/**/tmp/**</programlisting>
<programlisting>**/bin/**/tmp/**</programlisting>
That pattern matches the following paths:
<programlisting format='linespecific' xml:space='preserve'>
c:/spring/foo/bin/bar/tmp/a
<programlisting>c:/spring/foo/bin/bar/tmp/a
c:/spring/foo/bin/tmp/a/b.c</programlisting>
but does not match these:
<programlisting format='linespecific' xml:space='preserve'>
c:/spring/foo/bin/bar/temp/a
<programlisting>c:/spring/foo/bin/bar/temp/a
c:/tmp/foo/bin/bar/a/b.c</programlisting>
</para>
<para>
You can use more advanced patterns:
<programlisting format='linespecific' xml:space='preserve'>
**/.spring-assemblies*/**</programlisting>
<programlisting>**/.spring-assemblies*/**</programlisting>
matches:
<programlisting format='linespecific' xml:space='preserve'>
c:/.spring-assemblies
<programlisting>c:/.spring-assemblies
c:/.spring-assembliesabcd73xs
c:/app/.spring-assembliesabcd73xs
c:/app/.spring-assembliesabcd73xs/foo.dll
//server/app/.spring-assembliesabcd73xs</programlisting>
does not match:
<programlisting format='linespecific' xml:space='preserve'>
c:/app/.spring-assemblie</programlisting>
<programlisting>c:/app/.spring-assemblie</programlisting>
</para>
</sect2>
@@ -153,14 +154,11 @@ c:/app/.spring-assemblie</programlisting>
.NET is expected to be a cross-platform development ... platform. So,
<literal>PathMatcher</literal> will match taking care of the case of the pattern
and the case of the path. For example:
<programlisting format='linespecific' xml:space='preserve'>
**/db/**/*.DB</programlisting>
<programlisting>**/db/**/*.DB</programlisting>
matches:
<programlisting format='linespecific' xml:space='preserve'>
c:/spring/service/deploy/app/db/foo.DB</programlisting>
<programlisting>c:/spring/service/deploy/app/db/foo.DB</programlisting>
but does not match:
<programlisting format='linespecific' xml:space='preserve'>
c:/spring/service/deploy/app/DB/foo.DB
<programlisting>c:/spring/service/deploy/app/DB/foo.DB
c:spring/service/deploy/app/spaced dir/DB/foo.DB
//server/share/service/deploy/app/DB/backup/foo.db</programlisting>
</para>
@@ -169,11 +167,9 @@ c:spring/service/deploy/app/spaced dir/DB/foo.DB
<para>
Back and forward slashes, in the very same cross-platform spirit, are
not important:
<programlisting format='linespecific' xml:space='preserve'>
spring/foo.bar</programlisting>
<programlisting>spring/foo.bar</programlisting>
matches all the following paths:
<programlisting format='linespecific' xml:space='preserve'>
c:\spring\foo.bar
<programlisting>c:\spring\foo.bar
c:/spring\foo.bar
c:/spring/foo.bar
/spring/foo.bar