Adding documentation
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
Debucquoy Anthony 2023-05-10 23:09:03 +02:00
parent a472df26ed
commit a35d823ec4
Signed by: tonitch
GPG Key ID: A78D6421F083D42E
2 changed files with 6 additions and 6 deletions

View File

@ -1,8 +1,8 @@
--- <!-- --- -->
title: File Parser <!-- title: File Parser -->
author: Debucquoy Anthony (tonitch) <!-- author: Debucquoy Anthony (tonitch) -->
date: 5 March 2023 <!-- date: 5 March 2023 -->
--- <!-- --- -->
# File Parser Specification # 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 For the Project, I wanted to challenge myself, I decided to do my own file parser with my own specification that would

View File

@ -14,7 +14,7 @@ public interface FileParser {
* @param file file to parse * @param file file to parse
* @param saved_data does the saved data should be added to the map * @param saved_data does the saved data should be added to the map
* @return Map Object parsed with file data * @return Map Object parsed with file data
* @see "TODO: Add Specification when done" * @see <a href="http://school.debucquoy.me/spec/FileParser.html#file-parser-specification"> Parser Specification</a>
* @throws FileNotFoundException if the file was not found or was not accessible * @throws FileNotFoundException if the file was not found or was not accessible
* @throws IOException if an I/O occurs * @throws IOException if an I/O occurs
*/ */