doc: add documentation

- Editor
- Panel (user, exercise)

Author: dewita

components/Editor/RichTextEditor.vue

@@ -275,10 +275,17 @@
       }
     }
 
+    /**
+     * Reset the text editor
+     * @param content
+     */
     reset(content: string = '<p></p>') {
       this.editor.setContent(content);
     }
 
+    /**
+     * Check if the text editor is empty
+     */
     get isEmpty(): boolean {
       return this.content === '<p></p>' || this.content === '<p><br></p>' || this.content === '';
     }

components/Exercise/ExercisesPanel.vue

@@ -59,31 +59,51 @@
       threshold: ratio
     };
 
-
+    /**
+     * return the number of selected tags
+     */
     get numberOfFilter() {
       return this.$accessor.tags.selectedTags.length
     }
 
+    /**
+     * return all the selected tags
+     */
     get confirmedTags(): SelectedTag[] {
       return this.$accessor.tags.selectedTags
     }
 
+    /**
+     * Return the searched title for an exercise
+     */
     get searchModel() {
       return this.$accessor.exercises.search_criterion.title
     }
 
+    /**
+     * Check if the search request is empty
+     */
     get isEmptySearchModel(): boolean {
       return this.$accessor.exercises.search_criterion.title === ""
     }
 
+    /**
+     * Return the number of exercises corresponding to the search request
+     */
     get nbOfResults(): number {
       return this.$accessor.exercises.metadata.totalItems
     }
 
+    /**
+     * Return all the fetched exercises
+     */
     get exercises(): Exercise[] {
       return this.$accessor.exercises.exercises
     }
 
+    /**
+     * formats the selection tag according to the quotation in a human readable way
+     */
     get voteTag(): { title: string, id: number, state: TagState } | undefined {
       const vote = this.$accessor.exercises.search_criterion.vote;
       let title = '';
@@ -102,6 +122,9 @@
       return undefined
     }
 
+    /**
+     * Refresh the size of the box containing all exercises if the number of selected tags change
+     */
     @Watch('numberOfFilter')
     onNumberOfFilterChange() {
       this.$nextTick(() => {
@@ -115,6 +138,9 @@
       })
     }
 
+    /**
+     * Remove the rating criteria and refresh the search request
+     */
     async removeRatingCriteria() {
       await this.$accessor.exercises.RESET_VOTE();
       await this.$accessor.exercises.fetch({});
@@ -129,6 +155,11 @@
       })
     }
 
+    /**
+     * Remove on tag from the search request and fetch the exercises
+     * @param event
+     * @param tag
+     */
     async deleteTag(event: TagLabelObjectEmitted, tag: SelectedTag) {
       await this.$accessor.tags.addOrRemoveTag({...tag, isSelected: false});
       await this.$accessor.tags.apply('default');
@@ -144,6 +175,9 @@
       })
     }
 
+    /**
+     * Reset the search request
+     */
     async reset() {
       this.$accessor.tags.CLEAR();
       this.$accessor.exercises.RESET_SEARCH_CRITERION();

components/Exercise/PreviewExercise.vue

@@ -29,15 +29,32 @@
     export default class PreviewExercise extends Vue {
         @Prop({type: Object, required: true}) readonly exercise!: Exercise;
 
-        get metaTitleLink() {
+      /**
+       * Return the meta title of the exercise
+       */
+      get metaTitleLink() {
             return `${this.exercise.title} | Source Code`
         }
 
-        get metaLink() {
+      /**
+       * Return the link of the exercise containing its id
+       */
+      get metaLink() {
             return `/exercices/${this.exercise.id}`
         }
 
-        get tagsFormatted(): string {
+      /**
+       * return a formatted list of tags
+       * Here's the order :
+       * 1) cours
+       * 2) difficulté
+       * 3) langage
+       * 4) type d'exercice
+       * 5) thématique
+       *
+       * If a category does not contain any tag, it will be not display
+       */
+      get tagsFormatted(): string {
             const tags: ExerciseTag[] = this.exercise.tags;
 
             if(!tags) return '';
@@ -52,7 +69,7 @@
                 if (tag.category.category_text === 'cours' && orderedTextTags[0] === undefined) {
                     orderedTextTags[0] = tag.tag_text;
                     counter++
-                } else if (tag.category.category_text === 'langage' && orderedTextTags[1] === undefined) {
+                } else if (tag.category.category_text === 'difficulté' && orderedTextTags[1] === undefined) {
                   orderedTextTags[1] = tag.tag_text;
                   counter++
                 } else if (tag.category.category_text === 'langage' && orderedTextTags[2] === undefined) {
@@ -86,7 +103,10 @@
             return formatted
         }
 
-        get rating() {
+      /**
+       * Return the rating of the exercise
+       */
+      get rating() {
 
           const metrics = this.exercise.metrics;
 
@@ -98,14 +118,6 @@
           return '-'
 
         }
-
-        gotoExercise() {
-          if(this.$auth.loggedIn) {
-            this.$router.push(this.metaLink)
-          } else {
-            this.$router.push('/login')
-          }
-        }
     }
 </script>
 

components/Panel/Item/UserFilterPanel.vue

@@ -64,16 +64,19 @@
 
 
     /**
-     * A reference to each TagSelecter components
+     * A reference to each CheckBoxSelecter components
      */
     @Ref() checkBoxSelecter!: CheckBoxSelecter;
 
     /**
-     * The current opened tag selecter component
+     * The current opened CheckBoxSelecter component
      */
     selectedCheckBoxSelecter: CheckBoxSelecter | undefined = undefined;
 
 
+    /**
+     * Filter all users in terms of role
+     */
     setUserCriteria(event: CheckboxSelecterObjectEmitted[]) {
 
       const switchFunction = function (el: CheckboxSelecterObjectEmitted) {
@@ -121,7 +124,7 @@
     }
 
     /**
-     * Save the current tagSelecter or close a tag selecter if previously activated
+     * Save the current CheckBoxSelecter or close a CheckBoxSelecterif previously activated
      * @param userSelecter
      */
     toggleList(userSelecter: CheckBoxSelecter) {