cse110-fa21-group28 / meal-buddy

Meal Buddy is a web application that allows users to maintain a feed explicitly for various food recipes via Firebase.
0 stars 2 forks source link

Autogenerating Documentation through JSDoc #25

Closed kh1016 closed 2 years ago

kh1016 commented 2 years ago

Created the pipeline to autogenerate documentation with JSDocs. Not the prettiest but it has the bare minimum. The files for the documentation gets pushed to the gh-pages branch and so our repo's GitHub Pages will be referring to that branch. In order for JSDoc to generate documentation for the functions, we need to go through and write documentation for the individual functions inside the js files.

EX:

/**
 * Represents a book.
 * @constructor
 * @param {string} title - The title of the book.
 * @param {string} author - The author of the book.
 */
function Book(title, author) {
}

OR

/**
 * Gets the sum of two numbers
 * @param {Number} a - the first operand
 * @param {Number} b - the second operand
 * @returns the sum of a + b
 */
function sum(a, b) {
    return a + b;
}
github-actions[bot] commented 2 years ago

Visit the preview URL for this PR (updated for commit c881e5c):

https://meal-prep-web-app--pr25-jsdoc-a4iwsrfq.web.app

(expires Tue, 07 Dec 2021 01:10:53 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

thucngyyen commented 2 years ago

Looks very promising!