aboutsummaryrefslogtreecommitdiffstats
path: root/api/src
diff options
context:
space:
mode:
authorJulien Eluard <[email protected]>2012-02-02 13:03:02 -0300
committerJulien Eluard <[email protected]>2012-02-02 13:03:02 -0300
commitaf2c9184a69ad2b3e1de9a41d5d00edda3c65f69 (patch)
tree719a7b641febe289395e535791a1e3e360d4bf8d /api/src
parentcc75ee2c28e0c12db102cb63fd1b6fb2232cd280 (diff)
Removed old documentation.
Diffstat (limited to 'api/src')
-rwxr-xr-xapi/src/site/apt/index.apt43
-rwxr-xr-xapi/src/site/apt/usage.apt.vm65
-rwxr-xr-xapi/src/site/site.xml32
3 files changed, 0 insertions, 140 deletions
diff --git a/api/src/site/apt/index.apt b/api/src/site/apt/index.apt
deleted file mode 100755
index bd76f26..0000000
--- a/api/src/site/apt/index.apt
+++ /dev/null
@@ -1,43 +0,0 @@
-~~
-~~ This software is licensed under the Apache 2 license, quoted below.
-~~
-~~ Copyright 2010 Julien Eluard
-~~
-~~ 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.
-~~
-
-Semantic Versioning
-
- Semantic Versioning provides tools to automatically validate if your project's version number follows Semantic Versioning principles as defined by {{{http://semver.org}Semantic Versioning}}.
-
-* CLI overview
-
- The CLI has the following functionality:
-
- * {{{./usage.html}Diff}} between two specifed JARs
-
- * {{{./usage.html}Check}} compatibility type between two specifed JARs
-
- * {{{./usage.html}Infer}} correct version of your JAR based on an previous version
-
- * {{{./usage.html}Validate}} if your JAR's version is compatible with a previous one
-
- []
-
-* API overview
-
- Semantic Versioning also provides an API for programmatically validating your project's version number. This API is used by
- {{{../enforcer-rule} the maven enforcer rule}}. If these tool is not sufficient to your needs, then
- the entry point to the API is {{{./apidocs/org/semver/Checker.html}Checker}}.
-
- []
diff --git a/api/src/site/apt/usage.apt.vm b/api/src/site/apt/usage.apt.vm
deleted file mode 100755
index a07f7be..0000000
--- a/api/src/site/apt/usage.apt.vm
+++ /dev/null
@@ -1,65 +0,0 @@
-#*
- * This software is licensed under the Apache 2 license, quoted below.
- *
- * Copyright 2010 Julien Eluard
- *
- * 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.
- *#
-
-What is this?
-
- This simple command line tool looks at Java JAR files and determine API changes.
- You might download self contained JAR file from {{{https://github.com/downloads/jeluard/semantic-versioning/semver-${project.version}.jar}github}}.
-
-
-Diff
-
- Dumps all changes between two JARs on standard output.
-
------------------------------
-% java -jar semantic-versioning-${project.version}.jar previousJar currentJar (includes) (excludes)
-Class org.project.MyClass
- Added Class
-Class org.project.MyClass2
- Added Method method1
- Removed Field field1
- Changed Field field2 removed: final
-
------------------------------
-
-Check
-
- Checks compatibility type between two JARs.
-
------------------------------
-% java -jar semantic-versioning-${project.version}.jar previousJar currentJar (includes) (excludes)
-BACKWARD_COMPATIBLE_IMPLEMENTER
------------------------------
-
-Infer
-
- Infers JAR version based on a previously versioned JAR.
-
------------------------------
-% java -jar semantic-versioning-${project.version}.jar previousVersion previousJar currentJar (includes) (excludes)
-1.0.0
------------------------------
-
-Validate
-
- Validates JAR version based on a previously versioned JAR.
-
------------------------------
-% java -jar semantic-versioning-${project.version}.jar previousVersion previousJar currentVersion currentJar (includes) (excludes)
-true
------------------------------
diff --git a/api/src/site/site.xml b/api/src/site/site.xml
deleted file mode 100755
index 5934f1a..0000000
--- a/api/src/site/site.xml
+++ /dev/null
@@ -1,32 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-
- This software is licensed under the Apache 2 license, quoted below.
-
- Copyright 2010 Julien Eluard
-
- 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.
-
--->
-
-<project>
- <body>
- <menu ref="parent"/>
- <menu name="Overview">
- <item name="Introduction" href="index.html" />
- <item name="Usage" href="usage.html" />
- </menu>
- <menu ref="reports" />
- </body>
-</project>
-