Whitespace tweaks, OTB formatting, Doxygen update while I tour RCXlib

Author: jverne

Doxyfile

@@ -153,7 +153,7 @@ SHORT_NAMES            = NO
 # comments will behave just like regular Qt-style comments
 # (thus requiring an explicit @brief command for a brief description.)
 
-JAVADOC_AUTOBRIEF      = YES
+JAVADOC_AUTOBRIEF      = NO
 
 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
 # interpret the first line (until the first dot) of a Qt-style

compiler/AddrOfExpr.h

@@ -11,7 +11,6 @@
  * All Rights Reserved.
  *
  */
-
 #ifndef __AddrOfExpr_h
 #define __AddrOfExpr_h
 
@@ -26,23 +25,22 @@
 class AddrOfExpr : public Expr, public Translatable
 {
 public:
-                AddrOfExpr(int value, int offset, const LexLocation &loc);
-
+    AddrOfExpr(int value, int offset, const LexLocation &loc);
 
-        virtual bool		PromiseConstant() const;
+    virtual bool        PromiseConstant() const;
 
-        virtual bool		Evaluate(int &value) const;
-        virtual Expr*		Clone(Mapping *b) const;
+    virtual bool        Evaluate(int &value) const;
+    virtual Expr*       Clone(Mapping *b) const;
 
-        virtual bool		Contains(int var) const;
-        virtual RCX_Value	EmitAny_(Bytecode &b) const;
-        virtual RCX_Value	GetStaticEA_() const;
-        virtual bool            LValueIsPointer() const;
+    virtual bool        Contains(int var) const;
+    virtual RCX_Value   EmitAny_(Bytecode &b) const;
+    virtual RCX_Value   GetStaticEA_() const;
+    virtual bool        LValueIsPointer() const;
 
-        void				Translate(int from, int to);
+    void                Translate(int from, int to);
 private:
-        int				fValue;
-        int                             foffset;
+    int                 fValue;
+    int                 foffset;
 };
 
 

compiler/AsmStmt.h

@@ -10,24 +10,6 @@
  * Portions created by John Hansen are Copyright (C) 2005 John Hansen.
  * All Rights Reserved.
  *
- */ /*
- * The contents of this file are subject to the Mozilla Public License
- * Version 1.0 (the "License"); you may not use this file except in
- * compliance with the License. You may obtain a copy of the License at
- * http://www.mozilla.org/MPL/
- *
- * Software distributed under the License is distributed on an "AS IS"
- * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
- * License for the specific language governing rights and limitations
- * under the License.
- *
- * The Initial Developer of this code is David Baum.
- * Portions created by David Baum are Copyright (C) 1998 David Baum.
- * All Rights Reserved.
- *
- * Portions created by John Hansen are Copyright (C) 2005 John Hansen.
- * All Rights Reserved.
- *
  */
 
 #ifndef __AsmStmt_h

compiler/LabelStmt.h

@@ -12,7 +12,7 @@
  *
  */
 
-/*
+/**
  * LabelStmts are used to bind a label to another statement.  The
  * LabelStmt isn't really a statement itself - just a wrapper for
  * a single child statement.

nqc/CmdLine.h

@@ -26,7 +26,7 @@ class CmdLine
     CmdLine() : fPos(0) {};
     ~CmdLine();
 
-    void Add(const char *a); // make copy and add to arglist
+    void Add(const char *a);    // make copy and add to arglist
     void Add(int argc, const char * const *argv);   // add multiple args
 
     void Parse(const char *line, int skip = 0);     // parse line and add args

nqc/SRecord.cpp

@@ -20,7 +20,7 @@ using std::strncmp;
 using std::memcpy;
 using std::isspace;
 
-#define kMaxLine	256
+#define kMaxLine 256
 
 typedef struct {
   int length;
@@ -63,7 +63,7 @@ typedef struct {
 #define IMAGE_MAXLEN    0x8000
 #define TRANSFER_SIZE   200
 
-#define SEGMENT_BREAK	1024
+#define SEGMENT_BREAK   1024
 
 static signed char ctab[256] = {
     -1,-1,-1,-1,-1,-1,-1,-1,  -1,-1,-1,-1,-1,-1,-1,-1,
@@ -201,15 +201,13 @@ int srec_load (FILE *file, UByte *image, int maxlen, image_t *image_def,
                 /* Start of a new segment? */
                 if (srec.addr - prevAddr >= SEGMENT_BREAK) {
                     segIndex++;
-                    if (segIndex >= numimage_def)
-                    {
+                    if (segIndex >= numimage_def) {
                       return 0;
                     }
-
-                        image_def->segments[segIndex].length = 0;
-                        segStartAddr = srec.addr;
-                        prevAddr = srec.addr - prevCount;
-                        image_def->segments[segIndex].offset = imageIndex + prevCount;
+                    image_def->segments[segIndex].length = 0;
+                    segStartAddr = srec.addr;
+                    prevAddr = srec.addr - prevCount;
+                    image_def->segments[segIndex].offset = imageIndex + prevCount;
                 }
 
             if (srec.addr < IMAGE_START ||
@@ -242,8 +240,9 @@ int srec_load (FILE *file, UByte *image, int maxlen, image_t *image_def,
                 image_def->segments[segIndex].length = pos+1;
     }
 
-        for (i = 0; i <= segIndex; i++)
-                length += image_def->segments[segIndex].length;
+    for (i = 0; i <= segIndex; i++) {
+        length += image_def->segments[segIndex].length;
+    }
 
     if (length == 0) {
       return 0;
@@ -254,13 +253,8 @@ int srec_load (FILE *file, UByte *image, int maxlen, image_t *image_def,
 
 bool SRecord::Read(FILE *fp, int maxLength)
 {
-	//char line[kMaxLine];
-	//char *ptr;
-	//int dataLen;
-	//int byte;
-
-	delete [] fData;
-	fData = new UByte[maxLength];
+    delete [] fData;
+    fData = new UByte[maxLength];
 
         segment_t segments[2];
         image_t image_def = { 0, &segments[0] };
@@ -277,26 +271,25 @@ bool SRecord::Read(FILE *fp, int maxLength)
 
 int SRecord::ReadHexByte(const char *ptr)
 {
-	int i;
-	int v = 0;
-	char c;
-	int n;
-
-	for(i=0; i<2; i++)
-	{
-		c = *ptr++;
-
-		if (c >= '0' && c <= '9')
-			n = c - '0';
-		else if (c >= 'A' && c <= 'F')
-			n = c - 'A' + 10;
-		else if (c >= 'a' && c <= 'f')
-			n = c - 'a' + 10;
-		else
-			return -1;
-
-		v = (v << 4) + n;
-	}
-
-	return v;
+    int i;
+    int v = 0;
+    char c;
+    int n;
+
+    for (i=0; i<2; i++) {
+        c = *ptr++;
+
+        if (c >= '0' && c <= '9')
+            n = c - '0';
+        else if (c >= 'A' && c <= 'F')
+            n = c - 'A' + 10;
+        else if (c >= 'a' && c <= 'f')
+            n = c - 'a' + 10;
+        else
+            return -1;
+
+        v = (v << 4) + n;
+    }
+
+    return v;
 }

nqc/SRecord.h

@@ -26,11 +26,11 @@ class SRecord
 {
 public:
     SRecord() : fLength(0), fStart(0), fData(0) {}
-    ~SRecord()  { delete [] fData; }
+    ~SRecord() { delete [] fData; }
 
-    int GetLength() const   { return fLength; }
-    const UByte* GetData() const     { return fData; }
-    int GetStart() const    { return fStart; }
+    int GetLength() const { return fLength; }
+    const UByte* GetData() const { return fData; }
+    int GetStart() const { return fStart; }
 
     bool Read(FILE *fp, int maxLength);
 

nqc/nqc.cpp

@@ -1055,21 +1055,18 @@ void PrintError(RCX_Result error, const char *filename)
             break;
         case kUsageError:
             PrintVersion();
-            fprintf(STDERR,"Usage error: try \'nqc -help\' to display options\n");
+            fprintf(STDERR, "Usage error: try \'nqc -help\' to display options\n");
             break;
         case kQuietError:
             break;
-
         case kRCX_PipeModeError:
-            fprintf(STDERR,"USB driver does not support -firmfast, CyberMaster, or Spybotics\n");
+            fprintf(STDERR, "USB driver does not support -firmfast, CyberMaster, or Spybotics\n");
             break;
-
         case kRCX_USBUnsupportedError:
-            fprintf(STDERR,"USB Tower not supported\n");
+            fprintf(STDERR, "USB Tower not supported\n");
             break;
-
         case kRCX_GhostNotFoundError:
-            fprintf(STDERR,"Ghost libraries are not installed properly\n");
+            fprintf(STDERR," Ghost libraries are not installed properly\n");
             break;
         default:
             fprintf(STDERR, "Error #%d\n", -error);
@@ -1086,8 +1083,7 @@ void PrintVersion()
 
 void PrintUsage()
 {
-    string s (sTargetNames[gTargetType]);
-    const char* targetName = s.c_str();
+    const char *targetName = getTarget(gTargetType)->fName;
 
     PrintVersion();
     fprintf(stdout,"Usage: nqc [options] [actions] [ - | filename ] [actions]\n");

rcxlib/RCX_Constants.h

@@ -11,6 +11,12 @@
  * All Rights Reserved.
  *
  */
+
+ /**
+  * @file RCX_Constants.h
+  * @brief LEGO brick opcodes, IO definitions, and constant values
+  */
+
 #ifndef __RCX_Constants_h
 #define __RCX_Constants_h
 

rcxlib/RCX_Pipe.cpp

@@ -11,6 +11,11 @@
  * All Rights Reserved.
  *
  */
+ /**
+  * @file RCX_Pipe.cpp
+  * @brief Superclass implementation of LEGO IR USB tower pipe
+  */
+
 #include "RCX_Pipe.h"
 
 void RCX_Pipe::FlushRead(int delay)