Project

General

Profile

Documentation #2411

ISIS Coding Standards Developer Documentation Indentation Issues

Added by Ian Humphrey almost 2 years ago.

Status:
Acknowledged
Priority:
Normal
Assignee:
-
Category:
API
Target version:
-
Impact:

Coding standards are adhered to in examples in the coding standards document for developers

Software Version:
Test Reviewer:

Description

(Developer Documentation)

The ISIS coding standards document (https://isis.astrogeology.usgs.gov/documents/CodingStandards/CodingStandards.html) has a few indentation issues regarding if statements.

In the Around Parentheses, Braces, and Brackets section, the code:
@if (condition) {
statement;
}@
should have two spaces before "statement;" in order to comply with indentation standards for ISIS.

In the Method Definition and Calls section, the two if staments in the code:
@// Correct form
int functionName() {
if ( success() )
// Incorrect form has space after function name
int functionName () {
if ( success () )@
should have two spaces indenting them as well.

Also available in: Atom PDF