Finish proto-prototypes for 249GURUtility

+- 249GURUtility.h
This commit is contained in:
Charles Descamps 2023-11-16 20:06:50 -07:00
parent 29bc5d4dee
commit 068d947b2a

View file

@ -131,7 +131,165 @@ Dependencies: ???
/*
Name: checkForUseOfLiterals (GUR 11 - 249)
Process: checks for
Process: checks for any C-type literal, warns if the literal is not a variable.
Might also warn if a literal is used over and over.
Function input/parameters: ???
Function output/parameters: ???
Function output/returned: ???
Device input/ ---: ???
Device output/ ---: ???
Dependencies: ???
*/
/*
Name: checkForBreakUsage (GUR 12 - 249)
Process: checks for the C keyword "break" used anywhere but within a switch code
block. Warns if a break statement is in a code block without "switch."
Function input/parameters: ???
Function output/parameters: ???
Function output/returned: ???
Device input/ ---: ???
Device output/ ---: ???
Dependencies: ???
*/
/*
Name: checkForGlobalVariables (GUR 13 - 249)
Process: checks for variables that are outside ANY code block. Warns if a
defined variable is outside any code block.
Function input/parameters: ???
Function output/parameters: ???
Function output/returned: ???
Device input/ ---: ???
Device output/ ---: ???
Dependencies: ???
*/
/*
Name: checkForTabs (GUR 14 - 249)
Process: checks for tabs being used. This is partially a warning, as Lev never
likes tabs. Warns if the "\t" character is detected.
Function input/parameters: ???
Function output/parameters: ???
Function output/returned: ???
Device input/ ---: ???
Device output/ ---: ???
Dependencies: ???
*/
/*
Name: checkForEmptyReturn (GUR 15 - 249)
Process: checks for any return without a value attached. Warns if there is a
return inside a code block with a semicolon directly after.
Function input/parameters: ???
Function output/parameters: ???
Function output/returned: ???
Device input/ ---: ???
Device output/ ---: ???
Dependencies: ???
*/
/*
Name: checkForContinue (GUR 16 - 249)
Process: checks for the continue keyword in any code block. Warns if the
keyword is used in any circumstance.
Function input/parameters: ???
Function output/parameters: ???
Function output/returned: ???
Device input/ ---: ???
Device output/ ---: ???
Dependencies: ???
*/
/*
Name: checkForIOFunctions (GUR 17 - 249)
Process: checks for IO functions in any code block. Warns the user when the IO
function count is less than 4 in any given code block.
Function input/parameters: ???
Function output/parameters: ???
Function output/returned: ???
Device input/ ---: ???
Device output/ ---: ???
Dependencies: ???
*/
/*
Name: checkForFunctionsInParameters (GUR 18 - 249)
Process: checks for function calls within code parameters. Warns the user of use
of functions being used as parameters, or within array brackets.
Function input/parameters: ???
Function output/parameters: ???
Function output/returned: ???
Device input/ ---: ???
Device output/ ---: ???
Dependencies: ???
*/
/*
Name: checkForEmptyIf (GUR 19 - 249)
Process: checks for empty if or else blocks. Warns the user if the code block for
an if statement or an else statement is empty.
Function input/parameters: ???
Function output/parameters: ???
Function output/returned: ???
Device input/ ---: ???
Device output/ ---: ???
Dependencies: ???
*/
/*
Name: checkForEightyCharacterLimit (GUR 20 - 249)
Process: checks for any line that exceeds 80 characters. Warns the user if any
line defined as between two "\n" characters exceeds 80.
Function input/parameters: ???
Function output/parameters: ???
Function output/returned: ???
Device input/ ---: ???
Device output/ ---: ???
Dependencies: ???
*/
/*
Name: checkForDisallowedOperations (GUR 21 - 249)
Process: checks for ternary operators, goto, for/each, keywords that aren't used
within CS249. Warns the user when any of these operations are used either
globally or within any code block.
Function input/parameters: ???
Function output/parameters: ???
Function output/returned: ???
Device input/ ---: ???
Device output/ ---: ???
Dependencies: ???
*/
/*
Name: checkForUnspecifiedFunctions (GUR 22 - 249)
Process: checks for use of any functions that are not within the original/given
header file. Warns the user if the compared header file is not like the
C file.
Function input/parameters: ???
Function output/parameters: ???
Function output/returned: ???
Device input/ ---: ???
Device output/ ---: ???
Dependencies: ???
*/
/*
Name: checkForUseOfShorthandOperators (GUR W1 - 249)
Process: checks for the use of shorthand operators. Warns the user if there is
any "++" "--" "+=" & "-=" inside code blocks
Function input/parameters: ???
Function output/parameters: ???
Function output/returned: ???
Device input/ ---: ???
Device output/ ---: ???
Dependencies: ???
*/
/*
Name: checkFor (GUR W? - 249)
Process: checks for
Function input/parameters: ???
Function output/parameters: ???
Function output/returned: ???