Documentation of Server File Source Code

Docs/Comments.txt

@@ -0,0 +1,75 @@
+Format: 2.0.2
+
+# This is the Natural Docs comments file for this project.  If you change
+# anything here, it will apply to THIS PROJECT ONLY.  You can edit the version
+# in Natural Docs' Config folder to make the changes apply to all projects,
+# but it's recommended that you edit this version instead.
+
+
+# Ignored Keywords
+# ------------------------------------------------------------------------
+
+# If you'd like to prevent keywords from being recognized by Natural Docs,
+# you can do it like this:
+#
+# Ignore Keywords:
+#    [keyword]
+#    [keyword]
+#    ...
+
+
+# Comment Types
+# ------------------------------------------------------------------------
+
+# Each Natural Docs comment has a corresponding type which determine its
+# behavior.  You can define your own here or override the settings of the
+# existing ones.
+#
+# Comment Type: [name]
+# Alter Comment Type: [name]
+#    Creates a new comment type or changes an existing one.
+#
+# Display Name: [name]
+# Plural Display Name: [name]
+#    The singular and plural name of the comment type as it should appear in
+#    the output.
+#
+# Simple Identifier: [name]
+#    The name of the comment type using only the letters A to Z.  No spaces,
+#    numbers, symbols, or Unicode allowed.  Defaults to the comment type name
+#    minus any unacceptable characters.  This is used to generate things like
+#    CSS class names.
+#
+# Scope: [normal|start|end|always global]
+#    How the comment affects scope.  Defaults to normal.
+#    normal        - The comment stays within the current scope.
+#    start         - The comment starts a new scope for all the comments
+#                    beneath it, like class comments.
+#    end           - The comment resets the scope back to global for all the
+#                    comments beneath it, like section comments.
+#    always global - The comment is defined as a global symbol, but does not
+#                    change the scope for any other comments.
+#
+# Flags: [flag], [flag], ...
+#    A combination of settings that apply to the comment type.
+#    Code, File, or Documentation
+#        Whether it's used to describe a code element, a file, or is a
+#        standalone documentation comment.  Defaults to Code.
+#    Variable Type
+#        Whether it describes a code element that can be used as a variable's
+#        type.
+#    Class Hierarchy or Database Hierarchy
+#        Whether it describes a code element that should be included in the
+#        class or database hierarchy.  Requires Scope: Start.
+#    Enum
+#        Whether it describes an enum.
+#
+# Keywords:
+#    [keyword]
+#    [keyword], [plural keyword]
+#    ...
+#    A list of the comment type's keywords.  Each line after the heading is
+#    the keyword and optionally its plural form for list comments.  You can
+#    reuse existing keywords to change their definition.  When using
+#    "Alter Comment Type", these keywords are added to the existing ones
+#    rather than replacing them.

Docs/Languages.txt

@@ -0,0 +1,95 @@
+Format: 2.0.2
+
+# This is the Natural Docs languages file for this project.  If you change
+# anything here, it will apply to THIS PROJECT ONLY.  You can edit the version
+# in Natural Docs' Config folder to make the changes apply to all projects,
+# but it's recommended that you edit this version instead.
+
+
+# Ignored Extensions
+# ------------------------------------------------------------------------
+
+# If you'd like to prevent certain file extensions from being scanned by
+# Natural Docs, you can do it like this:
+#
+# Ignore Extensions: [extension] [extension] ...
+
+
+# Languages
+# ------------------------------------------------------------------------
+
+# These settings define the languages Natural Docs knows how to parse.  You
+# can define your own here or override the settings of the existing ones.
+# Note that all lists are space separated so that commas can be used as
+# values.
+#
+# Language: [name]
+# Alter Language: [name]
+#    Defines a new language or alters an existing one.  Its name can use any
+#    characters.  If any of the properties below have an add/replace form, you
+#    must use that when using Alter Language.
+#
+#    The language Shebang Script is special.  It's entry is only used for
+#    extensions, and files with those extensions have their shebang (#!) lines
+#    read to determine the real language of the file.  Extensionless files are
+#    always treated this way.
+#
+#    The language Text File is also special.  It's treated as one big comment
+#    so you can put Natural Docs content in them without special symbols.
+#
+# Extensions: [extension] [extension] ...
+# [Add/Replace] Extensions: [extension] [extension] ...
+#    Defines the file extensions of the language's source files.
+#
+# Shebang Strings: [string] [string] ...
+# [Add/Replace] Shebang Strings: [string] [string] ...
+#    Defines a list of strings that can appear in the shebang (#!) line to
+#    designate that it's part of the language.
+#
+# Simple Identifier: [name]
+#    The name of the language using only the letters A to Z.  No spaces,
+#    numbers, symbols, or Unicode allowed.  Defaults to the language name
+#    minus any unacceptable characters.  This is used to generate things like
+#    CSS class names.
+#
+# Aliases: [alias] [alias] ...
+# [Add/Replace] Aliases: [alias] [alias] ...
+#    Defines alternate names for the language that can be used to start a code
+#    block.
+#
+#
+# Properties for Basic Language Support Only
+# ------------------------------------------------------------------------
+# If you're adding your own language to Natural Docs you must define these.
+#
+# Line Comments: [symbol] [symbol] ...
+#    Defines a space-separated list of symbols that are used for line comments,
+#    if any.
+#
+# Block Comments: [opening sym] [closing sym] [opening sym] [closing sym] ...
+#    Defines a space-separated list of symbol pairs that are used for block
+#    comments, if any.
+#
+# Member Operator: [symbol]
+#    Defines the default member operator symbol.  The default is a dot.
+#
+# Line Extender: [symbol]
+#    Defines the symbol that allows a prototype to span multiple lines if
+#    normally a line break would end it.
+#
+# Enum Values: [global|under type|under parent]
+#    Defines how enum values are referenced.  The default is global.
+#    global       - Values are always global, referenced as 'value'.
+#    under type   - Values are under the enum type, referenced as
+#                   'class.enum.value'.
+#    under parent - Values are under the enum's parent, referenced as
+#                   'class.value'.
+#
+# Case Sensitive: [yes|no]
+#    Defines whether the language's identifiers are case sensitive.  The
+#    default is yes.
+#
+# [Comment Type] Prototype Enders: [symbol] [symbol] ...
+#    When defined, Natural Docs will attempt to get a prototype from the code
+#    immediately following the comment type.  It stops when it reaches one of
+#    these symbols.  Use \n for line breaks.

Docs/Project.txt

@@ -0,0 +1,129 @@
+Format: 2.0.2
+
+# This is the file you use to provide information about your project.  It can
+# also be used to specify input and output settings so you don't have to
+# include them on the command line.
+
+
+# Project Information
+# ------------------------------------------------------------------------
+
+# This is where you specify general information about your project.
+#
+# Title: [text]
+#    The name of your project.  (R) and (TM) will be converted to their
+#    respective symbols.
+#
+# Subtitle: [text]
+#    A subtitle for your project.
+#
+# Copyright: [text]
+#    The copyright notice for your project.  (C) will be converted to the
+#    copyright symbol.
+#
+# Timestamp: [text]
+#    Text explaining when the documentation was generated.  The following
+#    substitutions are performed:
+#    m     - Single digit month, when possible.  January is "1".
+#    mm    - Always double digit month.  January is "01".
+#    mon   - Short month word.  January is "Jan".
+#    month - Long month word.  January is "January".
+#    d     - Single digit day, when possible.  1 is "1".
+#    dd    - Always double digit day.  1 is "01".
+#    day   - Day with text extension.  1 is "1st".
+#    yy    - Double digit year.  2017 is "17".
+#    yyyy  - Four digit year.  2017 is "2017".
+#    year  - Four digit year.  2017 is "2017".
+#
+# Style: [style]
+#    The style to apply to the generated documentation.  It can be the name of
+#    a CSS file in the project configuration folder or a subfolder that
+#    contains Style.txt.  Do not include ".css" if using a CSS file.
+
+
+# Source Code
+# ------------------------------------------------------------------------
+
+Source Folder: ../PyJudge
+
+
+
+# This is where you specify what files and folders Natural Docs should be
+# scanning.  If you use any of these options on the command line, this entire
+# section is ignored except for names and numbers.
+#
+# All paths are relative to the project configuration folder, which lets this
+# file remain portable across computers and not cause problems in version
+# control systems.  You can enter absolute paths and they will be converted
+# automatically.
+#
+# Source Folder: [path]
+#    Name: [name]
+#
+#    Specifies a folder which will be searched for source files.  If you have
+#    more than one, add the Name property to set how it will show up in the
+#    menu.
+
+
+# Source Filtering
+# ------------------------------------------------------------------------
+
+# If there are any subfolders in the source code that you would like Natural
+# Docs to ignore, they can be specified here.  If you use any of these options
+# on the command line, this entire section is ignored.
+#
+# Ignore Source Folder: [path]
+#    Tells Natural Docs to skip this folder when scanning files.
+#
+# Ignore Source Folder Pattern: [pattern]
+#    Tells Natural Docs to skip all folder names which match this pattern when
+#    scanning files.  ? matches a single character, * matches zero or more
+#    characters.  It applies to the entire folder name, so "cli" will not
+#    match "client", although "cli*" will.
+#
+#    The data folders of common version control systems (.git, .svn, .cvs, .hg)
+#    are ignored automatically.  You do not have to specify them here.
+
+
+# Generated Documentation
+# ------------------------------------------------------------------------
+
+HTML Output Folder: .
+
+
+# This is where you specify what kind of documentation you want Natural Docs
+# to build and where it should be put.  If you use any of these options on the
+# command line, this entire section is ignored except for secondary settings.
+#
+# All paths are relative to the project configuration folder, which lets this
+# file remain portable across computers and not cause problems in version
+# control systems.  You can enter absolute paths and they will be converted
+# automatically.
+#
+# You can override any of the project information settings under each entry,
+# so if you have multiple output folders you can give them each different
+# styles or subtitles.
+#
+# HTML Output Folder: [path]
+#    [Project Information]
+#
+#    Generates HTML documentation in the specified folder.
+
+
+# Global Settings
+# ------------------------------------------------------------------------
+
+# Other settings that apply to your entire project.  Settings specified on the
+# command line override the settings here.
+#
+# Tab Width: [width]
+#    The number of spaces tabs should be expanded to.
+#
+# Documented Only: [yes|no]
+#    Whether only documented code elements should appear in the output.
+#    Defaults to no.
+#
+# Auto Group: [yes|no]
+#    Whether groups should automatically apply to you code.  Defaults to yes.
+
+

Docs/classes/Python/Contest-ToolTips.js

@@ -0,0 +1 @@
+NDContentPage.OnToolTipsLoaded({});

Docs/classes/Python/Contest.html

@@ -0,0 +1,17 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Contest</title><link rel="stylesheet" type="text/css" href="../../styles/main.css" /><script type="text/javascript" src="../../styles/main.js"></script><script type="text/javascript">NDLoader.LoadJS("Content", "../../styles/");</script></head>
+
+<!-- Generated by Natural Docs, version 2.0.2 -->
+
+<!-- saved from url=(0016)http://localhost -->
+
+<body onload="NDLoader.OnLoad('Content');" class="NDPage NDContentPage">
+
+<a name="Topic3"></a><div class="CTopic TClass LPython first">
+ <div class="CTitle">Contest</div>
+ <div class="NDClassPrototype HasParents" id="NDClassPrototype3"><div class="CPEntry Parent TClass"><div class="CPName">Model</div></div><div class="CPEntry TClass Current"><div class="CPName">Contest</div></div></div>
+ <div class="CBody"><p>Each Contest instance contains:- Code Description of contest Contest start time and End Time</p></div>
+</div>
+
+</body></html>

Docs/classes/Python/ContestProblems-ToolTips.js

@@ -0,0 +1 @@
+NDContentPage.OnToolTipsLoaded({});

Docs/classes/Python/ContestProblems.html

@@ -0,0 +1,17 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>ContestProblems</title><link rel="stylesheet" type="text/css" href="../../styles/main.css" /><script type="text/javascript" src="../../styles/main.js"></script><script type="text/javascript">NDLoader.LoadJS("Content", "../../styles/");</script></head>
+
+<!-- Generated by Natural Docs, version 2.0.2 -->
+
+<!-- saved from url=(0016)http://localhost -->
+
+<body onload="NDLoader.OnLoad('Content');" class="NDPage NDContentPage">
+
+<a name="Topic5"></a><div class="CTopic TClass LPython first">
+ <div class="CTitle">ContestProblems</div>
+ <div class="NDClassPrototype HasParents" id="NDClassPrototype5"><div class="CPEntry Parent TClass"><div class="CPName">Model</div></div><div class="CPEntry TClass Current"><div class="CPName">ContestProblems</div></div></div>
+ <div class="CBody"><p>All contest problems belong to a Contest and are itself a question.&nbsp; contest defines the instance of Contest Class it belongs question defines the questions that belongs to that contest.</p></div>
+</div>
+
+</body></html>

Docs/classes/Python/Question-ToolTips.js

@@ -0,0 +1 @@
+NDContentPage.OnToolTipsLoaded({});

Docs/classes/Python/Question.html

@@ -0,0 +1,17 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Question</title><link rel="stylesheet" type="text/css" href="../../styles/main.css" /><script type="text/javascript" src="../../styles/main.js"></script><script type="text/javascript">NDLoader.LoadJS("Content", "../../styles/");</script></head>
+
+<!-- Generated by Natural Docs, version 2.0.2 -->
+
+<!-- saved from url=(0016)http://localhost -->
+
+<body onload="NDLoader.OnLoad('Content');" class="NDPage NDContentPage">
+
+<a name="Topic4"></a><div class="CTopic TClass LPython first">
+ <div class="CTitle">Question</div>
+ <div class="NDClassPrototype HasParents" id="NDClassPrototype4"><div class="CPEntry Parent TClass"><div class="CPName">Model</div></div><div class="CPEntry TClass Current"><div class="CPName">Question</div></div></div>
+ <div class="CBody"><p>Each Question has a Question no and a author associated to it</p></div>
+</div>
+
+</body></html>

Docs/classes/Python/Session-ToolTips.js

@@ -0,0 +1 @@
+NDContentPage.OnToolTipsLoaded({});