diff --git a/src/main/java/Main.java b/src/main/java/Main.java index faf60cb..78cb65c 100644 --- a/src/main/java/Main.java +++ b/src/main/java/Main.java @@ -1,8 +1,6 @@ import app.AppModule; import com.google.inject.Guice; import com.google.inject.Injector; -import presenters.MainPresenter; -import presenters.NavPresenter; import ui.implementation.components.nav.NavBar; import ui.implementation.views.MainView; import ui.interfaces.IMainView; diff --git a/src/main/java/app/AppModule.java b/src/main/java/app/AppModule.java index 9eff494..8774c4a 100644 --- a/src/main/java/app/AppModule.java +++ b/src/main/java/app/AppModule.java @@ -17,6 +17,7 @@ import ui.interfaces.IMainView; import ui.interfaces.INavBar; /** + * Gathers some configurations in order to set the dependency injection container up * @author Laurent Crema */ public class AppModule extends AbstractModule { diff --git a/src/main/java/app/INavigator.java b/src/main/java/app/INavigator.java index 49361e3..dd3d26e 100644 --- a/src/main/java/app/INavigator.java +++ b/src/main/java/app/INavigator.java @@ -1,7 +1,14 @@ package app; +/** + * Provides some endpoints to browse between views + * @author Laurent Crema + */ public interface INavigator { + /** + * Displays Fourier view + */ void showFourier(); } diff --git a/src/main/java/app/SwingNavigator.java b/src/main/java/app/SwingNavigator.java index a264057..ab48e46 100644 --- a/src/main/java/app/SwingNavigator.java +++ b/src/main/java/app/SwingNavigator.java @@ -4,6 +4,11 @@ import com.google.inject.Inject; import com.google.inject.Provider; import ui.implementation.views.DoubleMatrix; +/** + * Concrete implement of the INavigator interface. + * Implements abstract endpoints to displays views in a Swing way + * @author Laurent Crema + */ public class SwingNavigator implements INavigator { private final Provider doubleMatrixProvider; diff --git a/src/main/java/app/state/AppState.java b/src/main/java/app/state/AppState.java index 4d7e9af..d0ff4fc 100644 --- a/src/main/java/app/state/AppState.java +++ b/src/main/java/app/state/AppState.java @@ -8,6 +8,9 @@ import domain.events.ImageChangedEvent; import domain.events.ModeChangedEvent; import domain.image.Image; +/** + * Represents the global state of the app + */ @Singleton public class AppState extends State { diff --git a/src/main/java/app/state/State.java b/src/main/java/app/state/State.java index cded0ad..83f5b35 100644 --- a/src/main/java/app/state/State.java +++ b/src/main/java/app/state/State.java @@ -2,6 +2,12 @@ package app.state; import com.google.common.eventbus.EventBus; +/** + * Represents any states that could ever exist. + * In order to notify the caller about any change made to internal properties of a children state, the caller + * must register itself + * @author Laurent Crema + */ public abstract class State { protected EventBus eventBus; @@ -10,6 +16,10 @@ public abstract class State { this.eventBus = eventBus; } + /** + * Register the caller so it can be notifed from changes within the state + * @param obj the caller itself + */ public void register(Object obj) { eventBus.register(obj); } diff --git a/src/main/java/domain/common/Mode.java b/src/main/java/domain/common/Mode.java index f81bb93..8ff7107 100644 --- a/src/main/java/domain/common/Mode.java +++ b/src/main/java/domain/common/Mode.java @@ -1,5 +1,9 @@ package domain.common; +/** + * Provides some pseudo-types to identify a drawing mode + * @author Laurent Crema + */ public enum Mode { DISABLED, DRAW_PIXEL, diff --git a/src/main/java/domain/image/GrayScaleMatrix.java b/src/main/java/domain/image/GrayScaleMatrix.java index b40b0a3..b6bcafb 100644 --- a/src/main/java/domain/image/GrayScaleMatrix.java +++ b/src/main/java/domain/image/GrayScaleMatrix.java @@ -5,6 +5,7 @@ import infrastructure.image.io.ImageSaver; import java.util.Arrays; /** + * Represents a matrix of gray-scaled pixels * @author Jean-Marc Wagner, Laurent Crema */ public class GrayScaleMatrix { diff --git a/src/main/java/domain/image/processing/complex/ComplexMatrix.java b/src/main/java/domain/image/processing/complex/ComplexMatrix.java index f45b103..a4fcedb 100644 --- a/src/main/java/domain/image/processing/complex/ComplexMatrix.java +++ b/src/main/java/domain/image/processing/complex/ComplexMatrix.java @@ -1,5 +1,8 @@ package domain.image.processing.complex; +/** + * @author Jean-Marc Wagner + */ public class ComplexMatrix { private Complexe m[][]; diff --git a/src/main/java/domain/image/processing/complex/Complexe.java b/src/main/java/domain/image/processing/complex/Complexe.java index 44d18d7..212e79a 100644 --- a/src/main/java/domain/image/processing/complex/Complexe.java +++ b/src/main/java/domain/image/processing/complex/Complexe.java @@ -1,5 +1,8 @@ package domain.image.processing.complex; +/** + * @author Jean-Marc Wagner + */ public class Complexe { private double partieReelle; diff --git a/src/main/java/domain/image/processing/fourier/Fourier.java b/src/main/java/domain/image/processing/fourier/Fourier.java index fb85101..faf5b60 100644 --- a/src/main/java/domain/image/processing/fourier/Fourier.java +++ b/src/main/java/domain/image/processing/fourier/Fourier.java @@ -2,6 +2,9 @@ package domain.image.processing.fourier; import domain.image.processing.complex.ComplexMatrix; +/** + * @author Jean-Marc Wagner + */ public class Fourier { public static ComplexMatrix Fourier2D(double f[][]) diff --git a/src/main/java/domain/image/processing/histogram/Histogramme.java b/src/main/java/domain/image/processing/histogram/Histogramme.java index cb755ab..b8f5869 100644 --- a/src/main/java/domain/image/processing/histogram/Histogramme.java +++ b/src/main/java/domain/image/processing/histogram/Histogramme.java @@ -3,6 +3,9 @@ package domain.image.processing.histogram; import domain.image.GrayScaleMatrix; import domain.image.Image; +/** + * @author Jean-Marc Wagner + */ public class Histogramme { public static int[] Histogramme256(GrayScaleMatrix mat) { int M = mat.getHeight(); diff --git a/src/main/java/infrastructure/image/io/ImageLoader.java b/src/main/java/infrastructure/image/io/ImageLoader.java index 259b427..59471b1 100644 --- a/src/main/java/infrastructure/image/io/ImageLoader.java +++ b/src/main/java/infrastructure/image/io/ImageLoader.java @@ -8,6 +8,9 @@ import java.io.IOException; import domain.image.Image; import domain.image.Pixel; +/** + * @author Laurent Crema + */ public class ImageLoader { public static Image loadImage(File f) throws IOException { diff --git a/src/main/java/infrastructure/image/io/ImageSaver.java b/src/main/java/infrastructure/image/io/ImageSaver.java index fae14b0..d0692c4 100644 --- a/src/main/java/infrastructure/image/io/ImageSaver.java +++ b/src/main/java/infrastructure/image/io/ImageSaver.java @@ -4,6 +4,9 @@ import domain.image.Image; import java.io.IOException; +/** + * @author Laurent Crema + */ public class ImageSaver { public static void saveImage(Image image) throws IOException { diff --git a/src/main/java/infrastructure/ui/ImageMapper.java b/src/main/java/infrastructure/ui/ImageMapper.java index 7eb2245..e645822 100644 --- a/src/main/java/infrastructure/ui/ImageMapper.java +++ b/src/main/java/infrastructure/ui/ImageMapper.java @@ -5,6 +5,9 @@ import domain.image.Pixel; import java.awt.image.BufferedImage; +/** + * @author Laurent Crema + */ public final class ImageMapper { public static BufferedImage toBufferedImage(Image image) { diff --git a/src/main/java/services/ImageService.java b/src/main/java/services/ImageService.java index f9a7f2b..76efc87 100644 --- a/src/main/java/services/ImageService.java +++ b/src/main/java/services/ImageService.java @@ -12,6 +12,9 @@ import infrastructure.image.io.ImageSaver; import java.io.File; import java.io.IOException; +/** + * @author Laurent Crema + */ public class ImageService { private final AppState appState; diff --git a/src/main/java/services/ModeService.java b/src/main/java/services/ModeService.java index 922bc7a..13042e0 100644 --- a/src/main/java/services/ModeService.java +++ b/src/main/java/services/ModeService.java @@ -4,6 +4,9 @@ import app.state.AppState; import com.google.inject.Inject; import domain.common.Mode; +/** + * @author Laurent Crema + */ public class ModeService { private final AppState appState; diff --git a/src/main/java/ui/implementation/components/image/ImagePanel.java b/src/main/java/ui/implementation/components/image/ImagePanel.java index 28e1434..abc335d 100644 --- a/src/main/java/ui/implementation/components/image/ImagePanel.java +++ b/src/main/java/ui/implementation/components/image/ImagePanel.java @@ -8,7 +8,9 @@ import javax.swing.*; import java.awt.*; import java.awt.image.BufferedImage; - +/** + * @author Laurent Crema + */ public class ImagePanel extends JPanel { private BufferedImage image; private double scale; diff --git a/src/main/java/ui/implementation/components/intent/FileChooser.java b/src/main/java/ui/implementation/components/intent/FileChooser.java index dfcea99..02406f5 100644 --- a/src/main/java/ui/implementation/components/intent/FileChooser.java +++ b/src/main/java/ui/implementation/components/intent/FileChooser.java @@ -1,6 +1,10 @@ package ui.implementation.components.intent; import javax.swing.*; + +/** + * @author Laurent Crema + */ public class FileChooser extends JFileChooser { public FileChooser(String initialLocation) { diff --git a/src/main/java/ui/implementation/components/nav/Menu.java b/src/main/java/ui/implementation/components/nav/Menu.java index 4b5e58b..ba91c14 100644 --- a/src/main/java/ui/implementation/components/nav/Menu.java +++ b/src/main/java/ui/implementation/components/nav/Menu.java @@ -3,6 +3,9 @@ package ui.implementation.components.nav; import javax.swing.*; import java.net.URL; +/** + * @author Laurent Crema, Jean-Marc Wagner + */ public class Menu extends JMenu { public Menu(String title, JMenuItem... items) diff --git a/src/main/java/ui/implementation/components/nav/MenuItem.java b/src/main/java/ui/implementation/components/nav/MenuItem.java index 6277f52..5a69347 100644 --- a/src/main/java/ui/implementation/components/nav/MenuItem.java +++ b/src/main/java/ui/implementation/components/nav/MenuItem.java @@ -4,6 +4,9 @@ import javax.swing.*; import java.awt.event.ActionListener; import java.net.URL; +/** + * @author Laurent Crema, Jean-Marc Wagner + */ public class MenuItem extends JMenuItem { public MenuItem(String title, ActionListener listener) { diff --git a/src/main/java/ui/implementation/dialogs/GreyScaleImageCreatorDialog.java b/src/main/java/ui/implementation/dialogs/GreyScaleImageCreatorDialog.java index 5d2cd6c..d3c0160 100644 --- a/src/main/java/ui/implementation/dialogs/GreyScaleImageCreatorDialog.java +++ b/src/main/java/ui/implementation/dialogs/GreyScaleImageCreatorDialog.java @@ -3,6 +3,9 @@ package ui.implementation.dialogs; import java.awt.Color; import javax.swing.*; +/** + * @author Laurent Crema, Jean-Marc Wagner + */ public class GreyScaleImageCreatorDialog extends ImageCreatorDialog { private JSlider slider; diff --git a/src/main/java/ui/implementation/dialogs/GreyScalePicker.java b/src/main/java/ui/implementation/dialogs/GreyScalePicker.java index 5e6c35b..3782dc4 100644 --- a/src/main/java/ui/implementation/dialogs/GreyScalePicker.java +++ b/src/main/java/ui/implementation/dialogs/GreyScalePicker.java @@ -2,6 +2,9 @@ package ui.implementation.dialogs; import java.awt.Color; +/** + * @author Laurent Crema, Jean-Marc Wagner + */ public class GreyScalePicker extends javax.swing.JDialog { private int couleur; diff --git a/src/main/java/ui/implementation/dialogs/ImageCreatorDialog.java b/src/main/java/ui/implementation/dialogs/ImageCreatorDialog.java index e12a37d..ecefc91 100644 --- a/src/main/java/ui/implementation/dialogs/ImageCreatorDialog.java +++ b/src/main/java/ui/implementation/dialogs/ImageCreatorDialog.java @@ -4,6 +4,9 @@ import javax.swing.*; import java.awt.*; import java.awt.event.ActionEvent; +/** + * @author Laurent Crema, Jean-Marc Wagner + */ public abstract class ImageCreatorDialog extends JDialog { protected Color color; diff --git a/src/main/java/ui/implementation/dialogs/RGBImageCreatorDialog.java b/src/main/java/ui/implementation/dialogs/RGBImageCreatorDialog.java index 8adca0e..7999da6 100644 --- a/src/main/java/ui/implementation/dialogs/RGBImageCreatorDialog.java +++ b/src/main/java/ui/implementation/dialogs/RGBImageCreatorDialog.java @@ -3,6 +3,9 @@ package ui.implementation.dialogs; import javax.swing.*; import java.awt.*; +/** + * @author Laurent Crema, Jean-Marc Wagner + */ public class RGBImageCreatorDialog extends ImageCreatorDialog {