From a35d823ec4aa21387e01f07e8a8737dcc0c06661 Mon Sep 17 00:00:00 2001 From: Anthony Debucquoy Date: Wed, 10 May 2023 23:09:03 +0200 Subject: [PATCH] Adding documentation --- JournalDeBord/src/spec/FileParser.md | 10 +++++----- .../main/java/school_project/Parsers/FileParser.java | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/JournalDeBord/src/spec/FileParser.md b/JournalDeBord/src/spec/FileParser.md index f7b2942..d383abd 100644 --- a/JournalDeBord/src/spec/FileParser.md +++ b/JournalDeBord/src/spec/FileParser.md @@ -1,8 +1,8 @@ ---- -title: File Parser -author: Debucquoy Anthony (tonitch) -date: 5 March 2023 ---- + + + + + # File Parser Specification For the Project, I wanted to challenge myself, I decided to do my own file parser with my own specification that would diff --git a/app/src/main/java/school_project/Parsers/FileParser.java b/app/src/main/java/school_project/Parsers/FileParser.java index c20d0bc..0ee336d 100644 --- a/app/src/main/java/school_project/Parsers/FileParser.java +++ b/app/src/main/java/school_project/Parsers/FileParser.java @@ -14,7 +14,7 @@ public interface FileParser { * @param file file to parse * @param saved_data does the saved data should be added to the map * @return Map Object parsed with file data - * @see "TODO: Add Specification when done" + * @see Parser Specification * @throws FileNotFoundException if the file was not found or was not accessible * @throws IOException if an I/O occurs */