docs: added docs for all other remaining components

TODO

@@ -1,4 +1,7 @@
 #integrate login/signup flow
 #make no activity page
 #add notifications
-#integrate logout flow
+#integrate logout flow
+#change number of downloads
+#link file with activity
+#refresh request

src/components/common/notificationCard.js

@@ -1,6 +1,9 @@
 import React,{ Component } from 'react';
 import 'styles/main.scss';
 
+/**
+ * Component to render notifications.
+ */
 class NotificationCard extends Component {
   render() {
     return(

src/components/common/notifications.js

@@ -5,6 +5,9 @@ import polygon from 'assets/Polygon.svg';
 import notif from 'assets/notif.svg';
 import 'styles/main.scss';
 
+/**
+ * Notification component for Studyportal.
+ */
 class Notifications extends Component {
   render() {
     return(
@@ -31,7 +34,10 @@ class Notifications extends Component {
 export default Notifications;
 
 Notifications.propTypes = {
+  /** Identifies notification popup toggle status. */
   notifications: PropTypes.bool,
+  /** Function to toggle state of modals. */
   handleClick: PropTypes.func,
+  /** Function to close modals. */
   close: PropTypes.func
 };

src/components/common/userMenu.js

@@ -9,6 +9,9 @@ const mapStateToProps = state => {
   return { user: state };
 };
 
+/**
+ * User-Menu component for Studyportal.
+ */
 class UserMenu extends Component {
   render() {
     return(
@@ -39,8 +42,12 @@ class UserMenu extends Component {
 export default connect(mapStateToProps)(UserMenu);
 
 UserMenu.propTypes = {
+  /** Holds user data which is handled through Redux. */
   user: PropTypes.object,
+  /** Identifies user-menu popup toggle status */
   userMenu: PropTypes.bool,
+  /** Function to toggle state of modals */
   handleClick: PropTypes.func,
+  /** Function to close modals. */
   close: PropTypes.func
 };

src/components/coursecard/coursePage.js

@@ -17,6 +17,9 @@ function mapStateToProps(state) {
   return { user: state };
 }
 
+/**
+ * Coursepage component for Studyportal.
+ */
 class CoursePage extends Component {
     constructor(props) {
         super(props);
@@ -55,6 +58,11 @@ class CoursePage extends Component {
       }
     }
 
+    /**
+     * Fetches files according to params.
+     *
+     * @param {object} nextProps
+     */
     getFiles(nextProps) {
       this.setState({ loading:true });
       getDepartmentInfoByAbbr(nextProps.department_abbr).then((res,err) => {
@@ -99,6 +107,11 @@ class CoursePage extends Component {
               });}}});}});
     }
 
+    /**
+     * Sorts files by creation date.
+     *
+     * @param {array} files
+     */
     sortFilesByYear(files) {
       if(!_.isEmpty(files)) {
         let years = [];
@@ -120,6 +133,11 @@ class CoursePage extends Component {
       else return files;
     }
 
+    /**
+     * Checks if this course is registered for the user.
+     *
+     * @param {object} props
+     */
     async checkCourse(props) {
       if(props.user.login) {
         this.setState({ mycourse:false });
@@ -130,6 +148,9 @@ class CoursePage extends Component {
       }
     }
 
+    /**
+     * Registers course for user.
+     */
     addCourse() {
       const token = getCookie('token');
       addCourseForUser(token,this.state.id).then((res,err) => {
@@ -143,6 +164,9 @@ class CoursePage extends Component {
       });
     }
 
+    /**
+     * Removes registered course from user.
+     */
     deleteCourse() {
       const token = getCookie('token');
       deleteCourseForUser(token,this.state.id).then((res,err) => {
@@ -245,10 +269,16 @@ class CoursePage extends Component {
 export default connect(mapStateToProps)(CoursePage);
 
 CoursePage.propTypes = {
+  /** Holds user data which is handled through Redux. */
   user: PropTypes.object,
+  /** Fetch user details from API. */
   getUserDetails: PropTypes.func,
+  /** Function to close modals. */
   close: PropTypes.func,
+  /** Holds course code for the course. */
   course_code: PropTypes.string,
+  /** Holds file type displayed currently. */
   file_type: PropTypes.string,
+  /** Holds department abbreviation for the department. */
   department_abbr: PropTypes.string
 };

src/components/coursecard/materialCard.js

@@ -10,6 +10,9 @@ import download1 from 'assets/download.svg';
 import download2 from 'assets/download1.svg';
 import CustomCheckbox from 'components/customcheckbox/customCheckbox';
 
+/**
+ * Component to render files.
+ */
 class MaterialCard extends Component {
     constructor(props) {
         super(props);
@@ -29,10 +32,16 @@ class MaterialCard extends Component {
         this.leave = this.leave.bind(this);
     }
 
+    /**
+     * Highlight download icon.
+     */
     hover() {
         this.setState({ queue: '1' });
     }
 
+    /**
+     * Remove highlight from download icon.
+     */
     leave() {
         this.setState({ queue: '2' });
     }
@@ -71,11 +80,18 @@ class MaterialCard extends Component {
 export default MaterialCard;
 
 MaterialCard.propTypes = {
+    /** Holds download icon highlight status. */
     queue: PropTypes.string,
+    /** Holds file name. */
     name: PropTypes.string,
+    /** Holds file size. */
     size: PropTypes.string,
+    /** Holds number of downloads. */
     downloads: PropTypes.number,
+    /** Holds driveid of the file. */
     url: PropTypes.string,
+    /** Holds file extension to display icon. */
     ext: PropTypes.string,
+    /** Holds creation date of file. */
     date_modified: PropTypes.string
 };

src/components/cover/courseCover.js

@@ -3,6 +3,9 @@ import PropTypes from 'prop-types';
 import courseselect from 'assets/course_select.svg';
 import 'styles/main.scss';
 
+/**
+ * Coursecover component for Studyportal.
+ */
 function CourseCover(props) {
   return (
   <div className='coursecover' onClick={props.close}>
@@ -15,5 +18,6 @@ function CourseCover(props) {
 export default CourseCover;
 
 CourseCover.propTypes = {
+  /** Function to close modals. */
   close: PropTypes.func
 };

src/components/cover/fileCover.js

@@ -3,6 +3,9 @@ import PropTypes from 'prop-types';
 import loader from 'assets/fileloader.svg';
 import 'styles/main.scss';
 
+/**
+ * Filecover component for Studyportal.
+ */
 function FileCover(props) {
   return (
   <div className='filecover' onClick={props.close}>
@@ -15,5 +18,6 @@ function FileCover(props) {
 export default FileCover;
 
 FileCover.propTypes = {
+  /** Function to close modals. */
   close: PropTypes.func
 };

src/components/customcheckbox/customCheckbox.js

@@ -2,6 +2,9 @@ import React, { Component } from 'react';
 import PropTypes from 'prop-types';
 import 'styles/main.scss';
 
+/**
+ * Component to render custom checkboxes.
+ */
 class CustomCheckbox extends Component {
     constructor(props) {
         super(props);
@@ -14,10 +17,16 @@ class CustomCheckbox extends Component {
         this.leave = this.leave.bind(this);
     }
 
+    /**
+     * Highlight checkbox.
+     */
     hover() {
         this.setState({ hover: true });
     }
 
+    /**
+     * Remove highlight from checkbox.
+     */
     leave() {
         this.setState({ hover: false });
     }
@@ -39,9 +48,14 @@ class CustomCheckbox extends Component {
 export default CustomCheckbox;
 
 CustomCheckbox.propTypes = {
+    /** Identifies checked status of checkbox. */
     value: PropTypes.bool,
+    /** Identifies the checkbox toggle status. */
     handleChange: PropTypes.func,
+    /** Holds border color for checkbox. */
     border: PropTypes.string,
+    /** Holds border color for checkbox on hover. */
     borderhover: PropTypes.string,
+    /** Holds colour displayed on higlight. */
     hover: PropTypes.string
 };

src/components/error/error.js

@@ -3,6 +3,9 @@ import PropTypes from 'prop-types';
 import { Link } from 'react-router-dom';
 import error from 'assets/error.svg';
 
+/**
+ * 404Page component for Studyportal.
+ */
 function Error(props) {
   return (
     <div className='error' onClick={props.close}>
@@ -22,5 +25,6 @@ function Error(props) {
 export default Error;
 
 Error.propTypes = {
+  /** Function to close modals. */
   close: PropTypes.func
 };

src/components/header/header.js

@@ -12,6 +12,9 @@ const mapStateToProps = state => {
     return { user: state };
 };
 
+/**
+ * Header component for Studyportal.
+ */
 class Header extends Component {
     render() {
         return(
@@ -72,12 +75,18 @@ class Header extends Component {
 export default connect(mapStateToProps)(Header);
 
 Header.propTypes = {
+    /** Holds status of user-menu popup. */
     userMenu: PropTypes.bool,
+    /** Holds status of notifications popup. */
     notifications: PropTypes.bool,
+    /** Holds status of search result popup. */
     search: PropTypes.bool,
+    /** Function to close modals. */
     close: PropTypes.func,
+    /** Function to toggle state of modals. */
     handleClick: PropTypes.func,
-    handleSeeAll: PropTypes.func,
+    /** Function to toggle see-all modal. */
     handleSeeAllClick: PropTypes.func,
+    /** Holds user data which is handled through Redux. */
     user: PropTypes.object
 };

src/components/header/search.js

@@ -8,6 +8,9 @@ import { getSearchResults } from 'api/searchApi';
 import { Link } from 'react-router-dom';
 import emoji from 'assets/mdi_sentiment_very_dissatisfied.svg';
 
+/**
+ * Component to render search.
+ */
 class Search extends Component {
     constructor(props) {
         super(props);
@@ -28,6 +31,11 @@ class Search extends Component {
         this.setState({ search:props.search });
     }
 
+    /**
+     * Fetches search result.
+     *
+     * @param {string} query
+     */
     getResults(query) {
       getSearchResults(query).then((res,err) => {
         if(err){
@@ -47,6 +55,11 @@ class Search extends Component {
       });
     }
 
+    /**
+     * Toggles search popup when text is typed in search bar.
+     *
+     * @param {object} e
+     */
     result(e) {
       this.setState({ value: e.target.value });
       if (e.target.value !== '') {
@@ -164,10 +177,14 @@ class Search extends Component {
 export default Search;
 
 Search.propTypes = {
+  /** Holds status of search popup. */
   search: PropTypes.bool,
+  /** Identifies whether search is in homepage. */
   home: PropTypes.bool,
+  /** Function to close modals. */
   close: PropTypes.func,
+  /** Function to toggle state of modals. */
   handleClick: PropTypes.func,
-  handleReqClick: PropTypes.func,
+  /** Function to toggle see-all modal. */
   handleSeeAllClick: PropTypes.func
 };

src/components/header/searchResult.js

@@ -7,6 +7,9 @@ import ppt from 'assets/material_ppt.svg';
 import img from 'assets/material_img.svg';
 import 'styles/main.scss';
 
+/**
+ * Component to render files.
+ */
 class SearchResult extends Component {
   constructor(props) {
     super(props);
@@ -53,11 +56,18 @@ class SearchResult extends Component {
 export default SearchResult;
 
 SearchResult.propTypes = {
+  /** Holds file name. */
   name: PropTypes.string,
+  /** Holds driveid of the file. */
   url: PropTypes.string,
+  /** Holds creation date of file. */
   date_modified: PropTypes.string,
+  /** Holds course title related to file. */
   course_name: PropTypes.string,
+  /** Holds course code related to file. */
   course_code: PropTypes.string,
+  /** Holds the type of file. */
   file_type: PropTypes.string,
+  /** Holds extension of file. */
   ext: PropTypes.string
 };