From cc3d70016ac5973a20a7cba8ca0b7d5c0bc32472 Mon Sep 17 00:00:00 2001 From: "pauline.prady" Date: Mon, 29 Apr 2024 18:47:33 +0200 Subject: [PATCH] Mise en place de la documentation --- .drone.yml | 24 + .../Diagramme_de_cas_d'utilisation.png | Bin .../Diagramme_de_cas_d'utilisation_Régle.png | Bin Documentation/doxygen/Doxyfile | 429 ++++++++++++++++++ .../personas/charlotte_basique.png | Bin .../personas/charlotte_informations.png | Bin .../personas/maxime_basique.png | Bin .../personas/maxime_informations.png | Bin .../personas/sabrine_basique.png | Bin .../personas/sabrine_informations.png | Bin .../sketchs/accueil.png | Bin .../sketchs/bravo.png | Bin .../sketchs/dommage.png | Bin .../sketchs/egalite.png | Bin .../sketchs/joueurs.png | Bin .../sketchs/plateau.png | Bin .../sketchs/regles.png | Bin .../sketchs/scores.png | Bin .../storyboard/Accueil.jpg | Bin .../storyboard/Classement.jpg | Bin .../storyboard/Connexion.jpg | Bin .../storyboard/Plateau.jpg | Bin .../storyboard/Regle.jpg | Bin .../storyboard/Resultat.jpg | Bin 24 files changed, 453 insertions(+) create mode 100644 .drone.yml rename {documentation => Documentation}/diagramme_cas_utilisations/Diagramme_de_cas_d'utilisation.png (100%) rename {documentation => Documentation}/diagramme_cas_utilisations/Diagramme_de_cas_d'utilisation_Régle.png (100%) create mode 100644 Documentation/doxygen/Doxyfile rename {documentation => Documentation}/personas/charlotte_basique.png (100%) rename {documentation => Documentation}/personas/charlotte_informations.png (100%) rename {documentation => Documentation}/personas/maxime_basique.png (100%) rename {documentation => Documentation}/personas/maxime_informations.png (100%) rename {documentation => Documentation}/personas/sabrine_basique.png (100%) rename {documentation => Documentation}/personas/sabrine_informations.png (100%) rename {documentation => Documentation}/sketchs/accueil.png (100%) rename {documentation => Documentation}/sketchs/bravo.png (100%) rename {documentation => Documentation}/sketchs/dommage.png (100%) rename {documentation => Documentation}/sketchs/egalite.png (100%) rename {documentation => Documentation}/sketchs/joueurs.png (100%) rename {documentation => Documentation}/sketchs/plateau.png (100%) rename {documentation => Documentation}/sketchs/regles.png (100%) rename {documentation => Documentation}/sketchs/scores.png (100%) rename {documentation => Documentation}/storyboard/Accueil.jpg (100%) rename {documentation => Documentation}/storyboard/Classement.jpg (100%) rename {documentation => Documentation}/storyboard/Connexion.jpg (100%) rename {documentation => Documentation}/storyboard/Plateau.jpg (100%) rename {documentation => Documentation}/storyboard/Regle.jpg (100%) rename {documentation => Documentation}/storyboard/Resultat.jpg (100%) diff --git a/.drone.yml b/.drone.yml new file mode 100644 index 0000000..b9361c7 --- /dev/null +++ b/.drone.yml @@ -0,0 +1,24 @@ +kind: pipeline +type: docker +name: default + +trigger: + event: + - push + +steps: + - name: generate-and-deploy-docs + image: hub.codefirst.iut.uca.fr/thomas.bellembois/codefirst-docdeployer + failure: ignore + volumes: + - name: docs + path: /docs + commands: + - /entrypoint.sh + when: + branch: + - master + event: + - push + - pull_request + depends_on: [build,tests] \ No newline at end of file diff --git a/documentation/diagramme_cas_utilisations/Diagramme_de_cas_d'utilisation.png b/Documentation/diagramme_cas_utilisations/Diagramme_de_cas_d'utilisation.png similarity index 100% rename from documentation/diagramme_cas_utilisations/Diagramme_de_cas_d'utilisation.png rename to Documentation/diagramme_cas_utilisations/Diagramme_de_cas_d'utilisation.png diff --git a/documentation/diagramme_cas_utilisations/Diagramme_de_cas_d'utilisation_Régle.png b/Documentation/diagramme_cas_utilisations/Diagramme_de_cas_d'utilisation_Régle.png similarity index 100% rename from documentation/diagramme_cas_utilisations/Diagramme_de_cas_d'utilisation_Régle.png rename to Documentation/diagramme_cas_utilisations/Diagramme_de_cas_d'utilisation_Régle.png diff --git a/Documentation/doxygen/Doxyfile b/Documentation/doxygen/Doxyfile new file mode 100644 index 0000000..5650d76 --- /dev/null +++ b/Documentation/doxygen/Doxyfile @@ -0,0 +1,429 @@ +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- +DOXYFILE_ENCODING = UTF-8 +PROJECT_NAME = "Mastermind" +PROJECT_NUMBER = 1.0.0 +PROJECT_BRIEF = "A brief description of your project" +PROJECT_LOGO = images/mylogo.png +OUTPUT_DIRECTORY = /docs/doxygen +CREATE_SUBDIRS = NO +ALLOW_UNICODE_NAMES = NO +OUTPUT_LANGUAGE = French +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the +ALWAYS_DETAILED_SEC = NO +INLINE_INHERITED_MEMB = NO +FULL_PATH_NAMES = YES +STRIP_FROM_PATH = +STRIP_FROM_INC_PATH = +SHORT_NAMES = NO +JAVADOC_AUTOBRIEF = NO +JAVADOC_BANNER = NO +QT_AUTOBRIEF = NO +MULTILINE_CPP_IS_BRIEF = NO +PYTHON_DOCSTRING = YES +INHERIT_DOCS = YES +SEPARATE_MEMBER_PAGES = NO +TAB_SIZE = 4 +ALIASES = +OPTIMIZE_OUTPUT_FOR_C = NO +# Well... the one for Java looks so similar to the one for C#... +OPTIMIZE_OUTPUT_JAVA = YES +OPTIMIZE_FOR_FORTRAN = NO +OPTIMIZE_OUTPUT_VHDL = NO +OPTIMIZE_OUTPUT_SLICE = NO +EXTENSION_MAPPING = +MARKDOWN_SUPPORT = YES +TOC_INCLUDE_HEADINGS = 5 +AUTOLINK_SUPPORT = YES +BUILTIN_STL_SUPPORT = NO +CPP_CLI_SUPPORT = NO +SIP_SUPPORT = NO +IDL_PROPERTY_SUPPORT = YES +DISTRIBUTE_GROUP_DOC = NO +GROUP_NESTED_COMPOUNDS = NO +SUBGROUPING = YES +INLINE_GROUPED_CLASSES = NO +INLINE_SIMPLE_STRUCTS = NO +TYPEDEF_HIDES_STRUCT = NO +LOOKUP_CACHE_SIZE = 0 +NUM_PROC_THREADS = 1 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +EXTRACT_ALL = YES +# I do not like other members to see my private members... but you can set it to YES if you prefer. +EXTRACT_PRIVATE = NO +EXTRACT_PRIV_VIRTUAL = NO +EXTRACT_PACKAGE = NO +EXTRACT_STATIC = YES +EXTRACT_LOCAL_CLASSES = YES +EXTRACT_LOCAL_METHODS = NO +EXTRACT_ANON_NSPACES = NO +RESOLVE_UNNAMED_PARAMS = YES +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO +HIDE_FRIEND_COMPOUNDS = NO +HIDE_IN_BODY_DOCS = NO +INTERNAL_DOCS = NO +CASE_SENSE_NAMES = NO +HIDE_SCOPE_NAMES = NO +HIDE_COMPOUND_REFERENCE= NO +SHOW_HEADERFILE = YES +SHOW_INCLUDE_FILES = YES +SHOW_GROUPED_MEMB_INC = NO +FORCE_LOCAL_INCLUDES = NO +INLINE_INFO = YES +SORT_MEMBER_DOCS = NO +SORT_BRIEF_DOCS = NO +SORT_MEMBERS_CTORS_1ST = NO +SORT_GROUP_NAMES = NO +SORT_BY_SCOPE_NAME = NO +STRICT_PROTO_MATCHING = NO +GENERATE_TODOLIST = YES +GENERATE_TESTLIST = YES +GENERATE_BUGLIST = YES +GENERATE_DEPRECATEDLIST= YES +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 30 +SHOW_USED_FILES = YES +SHOW_FILES = YES +SHOW_NAMESPACES = YES +FILE_VERSION_FILTER = +LAYOUT_FILE = +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +QUIET = NO +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_IF_DOC_ERROR = YES +WARN_IF_INCOMPLETE_DOC = YES +WARN_NO_PARAMDOC = NO +WARN_AS_ERROR = NO +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +INPUT = ../../Sources +INPUT_ENCODING = UTF-8 +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.l \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f18 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.ice +RECURSIVE = YES +EXCLUDE = +EXCLUDE_SYMLINKS = NO +EXCLUDE_PATTERNS = */Tests/* +EXCLUDE_PATTERNS += */bin/* +EXCLUDE_PATTERNS += */obj/* +EXCLUDE_SYMBOLS = +EXAMPLE_PATH = +EXAMPLE_PATTERNS = * +EXAMPLE_RECURSIVE = NO +IMAGE_PATH = +INPUT_FILTER = +FILTER_PATTERNS = +FILTER_SOURCE_FILES = NO +FILTER_SOURCE_PATTERNS = +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +SOURCE_BROWSER = NO +INLINE_SOURCES = NO +STRIP_CODE_COMMENTS = YES +REFERENCED_BY_RELATION = NO +REFERENCES_RELATION = NO +REFERENCES_LINK_SOURCE = YES +SOURCE_TOOLTIPS = YES +USE_HTAGS = NO +VERBATIM_HEADERS = YES +CLANG_ASSISTED_PARSING = NO +CLANG_ADD_INC_PATHS = YES +CLANG_OPTIONS = +CLANG_DATABASE_PATH = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +ALPHABETICAL_INDEX = YES +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +GENERATE_HTML = YES +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_HEADER = +HTML_FOOTER = footer.html +HTML_STYLESHEET = +HTML_EXTRA_STYLESHEET = +HTML_EXTRA_FILES = images/CodeFirst.png images/clubinfo.png +HTML_COLORSTYLE_HUE = 215 +HTML_COLORSTYLE_SAT = 45 +HTML_COLORSTYLE_GAMMA = 240 +HTML_TIMESTAMP = NO +HTML_DYNAMIC_MENUS = YES +HTML_DYNAMIC_SECTIONS = NO +HTML_INDEX_NUM_ENTRIES = 100 +GENERATE_DOCSET = NO +DOCSET_FEEDNAME = "Doxygen generated docs" +DOCSET_FEEDURL = +DOCSET_BUNDLE_ID = org.doxygen.Project +DOCSET_PUBLISHER_ID = org.doxygen.Publisher +DOCSET_PUBLISHER_NAME = Publisher +GENERATE_HTMLHELP = NO +CHM_FILE = +HHC_LOCATION = +GENERATE_CHI = NO +CHM_INDEX_ENCODING = +BINARY_TOC = NO +TOC_EXPAND = NO +GENERATE_QHP = NO +QCH_FILE = +QHP_NAMESPACE = org.doxygen.Project +QHP_VIRTUAL_FOLDER = doc +QHP_CUST_FILTER_NAME = +QHP_CUST_FILTER_ATTRS = +QHP_SECT_FILTER_ATTRS = +QHG_LOCATION = +GENERATE_ECLIPSEHELP = NO +ECLIPSE_DOC_ID = org.doxygen.Project +DISABLE_INDEX = NO +GENERATE_TREEVIEW = NO +FULL_SIDEBAR = NO +ENUM_VALUES_PER_LINE = 4 +TREEVIEW_WIDTH = 250 +EXT_LINKS_IN_WINDOW = NO +OBFUSCATE_EMAILS = YES +HTML_FORMULA_FORMAT = png +FORMULA_FONTSIZE = 10 +FORMULA_TRANSPARENT = YES +FORMULA_MACROFILE = +USE_MATHJAX = NO +MATHJAX_VERSION = MathJax_2 +MATHJAX_FORMAT = HTML-CSS +MATHJAX_RELPATH = +MATHJAX_EXTENSIONS = +MATHJAX_CODEFILE = +SEARCHENGINE = YES +SERVER_BASED_SEARCH = NO +EXTERNAL_SEARCH = NO +SEARCHENGINE_URL = +SEARCHDATA_FILE = searchdata.xml +EXTERNAL_SEARCH_ID = +EXTRA_SEARCH_MAPPINGS = + +#--------------------------------------------------------------------------- +# Configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +GENERATE_LATEX = NO +LATEX_OUTPUT = latex +LATEX_CMD_NAME = +MAKEINDEX_CMD_NAME = makeindex +LATEX_MAKEINDEX_CMD = makeindex +COMPACT_LATEX = NO +PAPER_TYPE = a4 +EXTRA_PACKAGES = +LATEX_HEADER = +LATEX_FOOTER = +LATEX_EXTRA_STYLESHEET = +LATEX_EXTRA_FILES = +PDF_HYPERLINKS = YES +USE_PDFLATEX = YES +LATEX_BATCHMODE = NO +LATEX_HIDE_INDICES = NO +LATEX_BIB_STYLE = plain +LATEX_TIMESTAMP = NO +LATEX_EMOJI_DIRECTORY = + +#--------------------------------------------------------------------------- +# Configuration options related to the RTF output +#--------------------------------------------------------------------------- + +GENERATE_RTF = NO +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the man page output +#--------------------------------------------------------------------------- + +GENERATE_MAN = NO +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_SUBDIR = +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# Configuration options related to the XML output +#--------------------------------------------------------------------------- + +GENERATE_XML = NO +XML_OUTPUT = xml +XML_PROGRAMLISTING = YES +XML_NS_MEMB_FILE_SCOPE = NO + +#--------------------------------------------------------------------------- +# Configuration options related to the DOCBOOK output +#--------------------------------------------------------------------------- + +GENERATE_DOCBOOK = NO +DOCBOOK_OUTPUT = docbook + +#--------------------------------------------------------------------------- +# Configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# Configuration options related to Sqlite3 output +#--------------------------------------------------------------------------- + +#--------------------------------------------------------------------------- +# Configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +GENERATE_PERLMOD = NO +PERLMOD_LATEX = NO +PERLMOD_PRETTY = YES +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = NO +EXPAND_ONLY_PREDEF = NO +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to external references +#--------------------------------------------------------------------------- + +TAGFILES = +GENERATE_TAGFILE = +ALLEXTERNALS = NO +EXTERNAL_GROUPS = YES +EXTERNAL_PAGES = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +DIA_PATH = +HIDE_UNDOC_RELATIONS = YES +HAVE_DOT = NO +DOT_NUM_THREADS = 0 +DOT_FONTNAME = Helvetica +DOT_FONTSIZE = 10 +DOT_FONTPATH = +CLASS_GRAPH = YES +COLLABORATION_GRAPH = YES +GROUP_GRAPHS = YES +UML_LOOK = NO +UML_LIMIT_NUM_FIELDS = 10 +DOT_UML_DETAILS = NO +DOT_WRAP_THRESHOLD = 17 +TEMPLATE_RELATIONS = NO +INCLUDE_GRAPH = YES +INCLUDED_BY_GRAPH = YES +CALL_GRAPH = NO +CALLER_GRAPH = NO +GRAPHICAL_HIERARCHY = YES +DIRECTORY_GRAPH = YES +DIR_GRAPH_MAX_DEPTH = 1 +DOT_IMAGE_FORMAT = png +INTERACTIVE_SVG = NO +DOT_PATH = +DOTFILE_DIRS = +MSCFILE_DIRS = +DIAFILE_DIRS = +PLANTUML_JAR_PATH = +PLANTUML_CFG_FILE = +PLANTUML_INCLUDE_PATH = +DOT_GRAPH_MAX_NODES = 50 +MAX_DOT_GRAPH_DEPTH = 0 +DOT_TRANSPARENT = NO +DOT_MULTI_TARGETS = NO +GENERATE_LEGEND = YES +DOT_CLEANUP = YES \ No newline at end of file diff --git a/documentation/personas/charlotte_basique.png b/Documentation/personas/charlotte_basique.png similarity index 100% rename from documentation/personas/charlotte_basique.png rename to Documentation/personas/charlotte_basique.png diff --git a/documentation/personas/charlotte_informations.png b/Documentation/personas/charlotte_informations.png similarity index 100% rename from documentation/personas/charlotte_informations.png rename to Documentation/personas/charlotte_informations.png diff --git a/documentation/personas/maxime_basique.png b/Documentation/personas/maxime_basique.png similarity index 100% rename from documentation/personas/maxime_basique.png rename to Documentation/personas/maxime_basique.png diff --git a/documentation/personas/maxime_informations.png b/Documentation/personas/maxime_informations.png similarity index 100% rename from documentation/personas/maxime_informations.png rename to Documentation/personas/maxime_informations.png diff --git a/documentation/personas/sabrine_basique.png b/Documentation/personas/sabrine_basique.png similarity index 100% rename from documentation/personas/sabrine_basique.png rename to Documentation/personas/sabrine_basique.png diff --git a/documentation/personas/sabrine_informations.png b/Documentation/personas/sabrine_informations.png similarity index 100% rename from documentation/personas/sabrine_informations.png rename to Documentation/personas/sabrine_informations.png diff --git a/documentation/sketchs/accueil.png b/Documentation/sketchs/accueil.png similarity index 100% rename from documentation/sketchs/accueil.png rename to Documentation/sketchs/accueil.png diff --git a/documentation/sketchs/bravo.png b/Documentation/sketchs/bravo.png similarity index 100% rename from documentation/sketchs/bravo.png rename to Documentation/sketchs/bravo.png diff --git a/documentation/sketchs/dommage.png b/Documentation/sketchs/dommage.png similarity index 100% rename from documentation/sketchs/dommage.png rename to Documentation/sketchs/dommage.png diff --git a/documentation/sketchs/egalite.png b/Documentation/sketchs/egalite.png similarity index 100% rename from documentation/sketchs/egalite.png rename to Documentation/sketchs/egalite.png diff --git a/documentation/sketchs/joueurs.png b/Documentation/sketchs/joueurs.png similarity index 100% rename from documentation/sketchs/joueurs.png rename to Documentation/sketchs/joueurs.png diff --git a/documentation/sketchs/plateau.png b/Documentation/sketchs/plateau.png similarity index 100% rename from documentation/sketchs/plateau.png rename to Documentation/sketchs/plateau.png diff --git a/documentation/sketchs/regles.png b/Documentation/sketchs/regles.png similarity index 100% rename from documentation/sketchs/regles.png rename to Documentation/sketchs/regles.png diff --git a/documentation/sketchs/scores.png b/Documentation/sketchs/scores.png similarity index 100% rename from documentation/sketchs/scores.png rename to Documentation/sketchs/scores.png diff --git a/documentation/storyboard/Accueil.jpg b/Documentation/storyboard/Accueil.jpg similarity index 100% rename from documentation/storyboard/Accueil.jpg rename to Documentation/storyboard/Accueil.jpg diff --git a/documentation/storyboard/Classement.jpg b/Documentation/storyboard/Classement.jpg similarity index 100% rename from documentation/storyboard/Classement.jpg rename to Documentation/storyboard/Classement.jpg diff --git a/documentation/storyboard/Connexion.jpg b/Documentation/storyboard/Connexion.jpg similarity index 100% rename from documentation/storyboard/Connexion.jpg rename to Documentation/storyboard/Connexion.jpg diff --git a/documentation/storyboard/Plateau.jpg b/Documentation/storyboard/Plateau.jpg similarity index 100% rename from documentation/storyboard/Plateau.jpg rename to Documentation/storyboard/Plateau.jpg diff --git a/documentation/storyboard/Regle.jpg b/Documentation/storyboard/Regle.jpg similarity index 100% rename from documentation/storyboard/Regle.jpg rename to Documentation/storyboard/Regle.jpg diff --git a/documentation/storyboard/Resultat.jpg b/Documentation/storyboard/Resultat.jpg similarity index 100% rename from documentation/storyboard/Resultat.jpg rename to Documentation/storyboard/Resultat.jpg