Added some javadoc

rossdrew · Nov 15, 2024 · 5368be7 · 5368be7
1 parent 2d7cc9f
commit 5368be7
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/src/main/java/com/rox/journal/entry/JournalEntriesService.java b/src/main/java/com/rox/journal/entry/JournalEntriesService.java
@@ -23,6 +23,12 @@ public class JournalEntriesService {
     private static final Pattern starting = Pattern.compile("_([^_]*)_");
     private static final Pattern completing = Pattern.compile("--([^--]*)--");
 
+    /**
+     * Append a {@link JournalEntry}
+     *
+     * @param entry the {@link JournalEntry} to append
+     * @return the provided {@link JournalEntry}
+     */
     public JournalEntry append(JournalEntry entry){
         entry = entry.at(new java.util.Date());
 
@@ -41,6 +47,12 @@ public JournalEntry append(JournalEntry entry){
         return entry;
     }
 
+    /**
+     * List all {@link JournalEntry} that match the provided {@link EntriesQuery}
+     *
+     * @param query {@link EntriesQuery} to run over all entries
+     * @return all matching {@link JournalEntry} objects wrapped in {@link PageWrapper}
+     */
     public PageWrapper<JournalEntry> list(final EntriesQuery query){
         if (testEntries.size() <= query.getStart())
             return PageWrapper.around(Collections.emptyList());