[daisy-pipeline.wiki] push by - Edited wiki page Versioning through web user interface. on 2013-08-27 11:51 GMT

[daisy-p...@googlecode.com]

Revision: ebabeb605ac2
Branch: default
Author: bert...@gmail.com
Date: Tue Aug 27 11:51:17 2013 UTC
Log: Edited wiki page Versioning through web user interface.
http://code.google.com/p/daisy-pipeline/source/detail?r=ebabeb605ac2&repo=wiki

Modified:
/Versioning.wiki

=======================================
--- /Versioning.wiki Mon Aug 26 14:21:05 2013 UTC
+++ /Versioning.wiki Tue Aug 27 11:51:17 2013 UTC
@@ -12,24 +12,31 @@

== Java ==

-API = everything that is declared public (or protected?) in exported
packages.
+API = everything that is declared public in exported packages.

-(what about implementations of services that are activated through DS?
these packages are exported, but they are not always part of an API.)
+ * what about protected?
+ * what about OSGi/DS methods (bind/activate)?
+
+=== XPath extensions for Saxon ===
+
+Same story, but of particular importance is what these functions return:
+
+ * `public StructuredQName getFunctionQName()`
+ * `public int getMinimumNumberOfArguments()`
+ * `public int getMaximumNumberOfArguments()`
+ * `public SequenceType[] getArgumentTypes()`
+ * `public SequenceType getResultType(SequenceType[]
suppliedArgumentTypes)`

== XProc ==

API = the signature of steps declared in files (`p:declare-step` /
`p:pipeline` / `p:library`) listed in the the bundle's catalog.xml.

-(question: what happens with transitive imports in XProc? and
sub-pipelines in an imported pipeline?)
-
== XSLT ==

API = templates/functions declared "public" using comments.

Because in XSLT there is no way to limit the visibility of code, we need
to declare the API using comments in the code. Ideally we separate
the "public" templates/functions in the head of the file and move the rest
below.

-(idea: should we have a tool that generates the documentation of our
public API? The tool would of course invoke javadoc, maybe xprocdoc, and
maybe a custom tool that extracts the public XSLT templates/functions.)
-
= Commit/release policy =

SemVer states that: