Add java docs

graphhopper · Dec 13, 2019 · de57fa4 · de57fa4
1 parent 402028f
commit de57fa4
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/core/src/main/java/com/graphhopper/storage/GraphHopperStorage.java b/core/src/main/java/com/graphhopper/storage/GraphHopperStorage.java
@@ -83,6 +83,10 @@ public void freeze() {
         chGraphs = new ArrayList<>();
     }
 
+    /**
+     * Adds a {@link CHGraph} for the given {@link CHProfile}. You need to call this method before calling {@link #create(long)}
+     * or {@link #loadExisting()}.
+     */
     public void addCHGraph(CHProfile chProfile) {
         baseGraph.checkNotInitialized();
         if (getCHProfiles().contains(chProfile)) {
@@ -91,6 +95,9 @@ public void addCHGraph(CHProfile chProfile) {
         chGraphs.add(new CHGraphImpl(chProfile, dir, baseGraph, segmentSize));
     }
 
+    /**
+     * @see #addCHGraph(CHProfile)
+     */
     public void addCHGraphs(List<CHProfile> chProfiles) {
         for (CHProfile chProfile : chProfiles) {
             addCHGraph(chProfile);