We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 943d610 commit 9fb601eCopy full SHA for 9fb601e
src/main/java/net/imagej/updater/FilesCollection.java
@@ -75,6 +75,18 @@
75
76
/**
77
* This class represents the database of available {@link FileObject}s.
78
+ * <p>
79
+ * By itself, a {@code FilesCollection} is fairly naive. If built around an
80
+ * existing installation, the first action to take after instantiation is often
81
+ * {@link #tryLoadingCollection()} - which will then recongnize update sites,
82
+ * etc...
83
+ * </p>
84
85
+ * After any updates to the {@code FilesCollection}, the {@link #write()} method
86
+ * is used to persist state to the {@code db.xml.gz} on disk. Note that this
87
+ * does not actually perform any file updates - the
88
+ * {@link net.imagej.updater.Installer} is required for such operations.
89
90
*
91
* @author Johannes Schindelin
92
*/
0 commit comments