Skip to content

Commit 7a38983

Browse files
committed
Add documentation
1 parent cfe1ffa commit 7a38983

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
package edu.wpi.grip.core;
22

3+
/**
4+
* Defines what methods a FileManager implementation must implement.
5+
*/
36
public interface FileManager {
7+
8+
/**
9+
* Saves an array of bytes to a file.
10+
*
11+
* @param image The image to save
12+
* @param fileName The file name to save
13+
*/
414
void saveImage(byte[] image, String fileName);
515
}

core/src/main/java/edu/wpi/grip/core/GripFileManager.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@
1010

1111
import static com.google.common.base.Preconditions.checkNotNull;
1212

13+
/**
14+
* Implementation of {@code FileManager}. Saves files into a directory named GRIP in the user's home folder.
15+
*/
1316
@Singleton
1417
public class GripFileManager implements FileManager {
1518

0 commit comments

Comments
 (0)