]> gitweb.factorcode.org Git - factor.git/commitdiff
add basic documentation
authorMaximilian Lupke <simply.malu@googlemail.com>
Mon, 22 Feb 2010 21:25:24 +0000 (22:25 +0100)
committerMaximilian Lupke <simply.malu@googlemail.com>
Tue, 23 Feb 2010 12:25:34 +0000 (13:25 +0100)
extra/semantic-versioning/semantic-versioning-docs.factor [new file with mode: 0644]

diff --git a/extra/semantic-versioning/semantic-versioning-docs.factor b/extra/semantic-versioning/semantic-versioning-docs.factor
new file mode 100644 (file)
index 0000000..6d10abc
--- /dev/null
@@ -0,0 +1,55 @@
+! Copyright (C) 2010 Maximilian Lupke.
+! See http://factorcode.org/license.txt for BSD license.
+USING: arrays help.markup help.syntax kernel strings ;
+IN: semantic-versioning
+
+HELP: split-version
+{ $values
+    { "string" string }
+    { "array" array }
+}
+{ $description "Splits the version string into a sequnece of major version, minor version, patch level and an alphanumeric identifier if given. See " { $url "http://semver.org/" } " for a detailed description." } ;
+
+HELP: version<
+{ $values
+    { "version1" string } { "version2" string }
+    { "?" boolean }
+} ;
+
+HELP: version<=
+{ $values
+    { "version1" string } { "version2" string }
+    { "?" boolean }
+} ;
+
+HELP: version<=>
+{ $values
+    { "version1" string } { "version2" string }
+    { "<=>" string }
+} ;
+
+HELP: version=
+{ $values
+    { "version1" string } { "version2" string }
+    { "?" boolean }
+} ;
+
+HELP: version>
+{ $values
+    { "version1" string } { "version2" string }
+    { "?" boolean }
+} ;
+
+HELP: version>=
+{ $values
+    { "version1" string } { "version2" string }
+    { "?" boolean }
+} ;
+
+ARTICLE: { "Versioning" "Semantic Versioning" } "Semantic Versioning"
+{ $vocab-link "semantic-versioning" }
+$nl
+{ "See " { $url "http://semver.org/" } " for a detailed description of semantic versioning." }
+;
+
+ABOUT: { "Versioning" "Semantic Versioning" }