commnets

backend/list_files.php

 <?php
 
-/*!
+/*! \file
 This script returns the code files present in a user's workspace, but doesn't account for directories and sub-directories.
 This script is obselete because of the script dir_tree.php, which returns the directory tree of the user's workspace.
 */

backend/register.php

 <?php
 
 /**  \file
-This script registers a user using a username, password, name, and email. 
-This script communicates with the MySQL server to save user data.
-Passowrd is hashed, and SQL injection is taken care of.
-The process of registering involves -
-1. An insert operation into the users table, in the database.
-2. Creation of directories, required to store files, executables and question attempts made by the user.
-
-Returns a 404 error if username already exists.
+* This script registers a user using a username, password, name, and email. 
+* This script communicates with the MySQL server to save user data.
+* Passowrd is hashed, and SQL injection is taken care of.
+* The process of registering involves -
+* 1. An insert operation into the users table, in the database.
+* 2. Creation of directories, required to store files, executables and question attempts made by the user.
+
+* Returns a 404 error if username already exists.
 */
 
 header("Access-Control-Allow-Origin: *");

src/app/directory.ts

+/** \file
+* Interface for Directory having attributes for storing it's child directories, files and the path where it is tored in the server.
+* Used in File management for providing User a workspace.
+*/
+
 import {File} from './file';
 
 export interface Directory {

src/app/file.ts

+/** \file
+* Interface for File having attributes for storing the extensions and contents of the file.
+* Used in services and components for storing the ide text and uploading the server, as well as 
+* compiling and executing programs.
+*/
+
 export interface File {
   username: string;
   filename: string;

src/app/problem.ts

+/** \file
+* A temporary Interface for Problem 
+*/
+
 export interface Problem {
   id: number;
   title: string;

src/app/question.ts

+/** \file
+* Interface for Question which are to be uploaded by different users.
+*/
+
 export interface Question {
     title: string;
     username: string;

src/app/run-code.service.ts

@@ -28,11 +28,6 @@ export class RunCodeService {
     });
   }
 
-  // compileProblemFile(prob: Problem): Observable<any> {
-  //   if (Math.floor(Math.random() * 2) === 1) {return of('done'); }
-  //   else {return throwError('error'); }
-  // }
-
   verifyTestcase(file: File, out: string, ind: number, isSubmit: number): Observable<any> {
     return this.httpClient.post(this.baseUrl + 'questions/check_output.php', {
       title: file.filename,

src/app/user.ts

+/**  \file
+* Interface for User containing his/her details and login credentials.
+* Used in services and components as a data structure for each user.
+*/
+
 export interface User {
   id: number;
   username: string;