Skip to content
Snippets Groups Projects
Commit d876adab authored by Daniel Hornung's avatar Daniel Hornung
Browse files

DOC: More documentation.

parent 230c6116
No related branches found
No related tags found
2 merge requests!21Release v0.4.0,!15Document server code structure
Pipeline #8466 passed
...@@ -197,10 +197,11 @@ Stand-alone documentation is built using Sphinx: `make doc` ...@@ -197,10 +197,11 @@ Stand-alone documentation is built using Sphinx: `make doc`
### Requirements ## ### Requirements ##
- plantuml
- recommonmark
- sphinx - sphinx
* sphinx-rtd-theme - sphinx-rtd-theme
* sphinxcontrib-plantuml - sphinxcontrib-plantuml
* recommonmark
- javasphinx :: `pip3 install --user javasphinx` - javasphinx :: `pip3 install --user javasphinx`
- Alternative, if javasphinx fails because python3-sphinx is too recent: - Alternative, if javasphinx fails because python3-sphinx is too recent:
(`l_` not found): (`l_` not found):
......
...@@ -26,7 +26,12 @@ import java.lang.annotation.Retention; ...@@ -26,7 +26,12 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy; import java.lang.annotation.RetentionPolicy;
import org.caosdb.server.transaction.TransactionInterface; import org.caosdb.server.transaction.TransactionInterface;
/** Jobs may be annotated with @JobAnnotation(...). */ /**
* Jobs may be annotated with @JobAnnotation(...).
*
* <p>Without a JobAnnotation, the Job will run at the default {@link
* org.caosdb.server.transaction.Transaction#check() CHECK} stage.
*/
@Retention(RetentionPolicy.RUNTIME) @Retention(RetentionPolicy.RUNTIME)
public @interface JobAnnotation { public @interface JobAnnotation {
JobExecutionTime time() default JobExecutionTime.CHECK; JobExecutionTime time() default JobExecutionTime.CHECK;
......
...@@ -30,7 +30,13 @@ import java.util.Map; ...@@ -30,7 +30,13 @@ import java.util.Map;
import java.util.concurrent.CopyOnWriteArrayList; import java.util.concurrent.CopyOnWriteArrayList;
import org.caosdb.server.entity.EntityInterface; import org.caosdb.server.entity.EntityInterface;
/** Keeps track of Jobs, ordered by "time". */ /**
* Keeps track of Jobs.
*
* <p>The Schedule class orders jobs by "time" and also assures that jobs are skipped when
* appropriate and to prevent that jobs run more than once (because sometimes they trigger each
* other).
*/
public class Schedule { public class Schedule {
private final Map<Integer, List<ScheduledJob>> jobLists = new HashMap<>(); private final Map<Integer, List<ScheduledJob>> jobLists = new HashMap<>();
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment