Changeset 3897

Timestamp:

05/23/07 22:04:10 (6 years ago)

Author:

jgaeddert

Message:

adding basic documentation

Location:

experimental/components/SymbolSyncPoly

Files:

• Doxyfile (modified) (3 diffs)
• documentation.txt (modified) (3 diffs)
• src/SymbolSyncPolyDSP.cpp (modified) (1 diff)

experimental/components/SymbolSyncPoly/Doxyfile

@@ -18 +18 @@
 # by quotes) that should identify the project.
 
-PROJECT_NAME           = "SymbolSyncPoly"
+PROJECT_NAME           = "Multi-rate Synchronization Component Library"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
@@ -462 +462 @@
 INPUT =                                     \
     documentation.txt                       \
-    src/SymbolSyncPoly.h                    \
-    src/SymbolSyncPoly.cpp                  \
-    src/SymbolSyncPolyDSP.h                 \
-    src/SymbolSyncPolyDSP.cpp               \
-    src/main_SymbolSyncPoly.cpp             \
-    src/MultirateSynchronizer.h             \
-    src/MultirateSynchronizer.cpp           \
-    src/MultirateSynchronizerDSP.h          \
-    src/MultirateSynchronizerDSP.cpp        \
-    src/main_MultirateSynchronizer.cpp
+    src/
 
 # If the value of the INPUT tag contains directories, you can use the 
@@ -480 +471 @@
 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
 
-FILE_PATTERNS          = 
+FILE_PATTERNS          = *.h *.cpp
 
 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 

experimental/components/SymbolSyncPoly/documentation.txt

@@ -3 +3 @@
 Copyright 2007 Virginia Polytechnic Institute and State University
 
-This file is part of the OSSIE SymbolSyncPoly.
+This file is part of the OSSIE Multi-rate Synchronization Component Library.
 
 OSSIE SymbolSyncPoly is free software; you can redistribute it and/or modify
@@ -21 +21 @@
 ****************************************************************************/
 
-/*! \mainpage Symbol Synchronizer: Polyphase Filter Bank
+/*! \mainpage Multi-rate Synchronization Component Library
 
 \section description Basic description
+  - SymbolSyncPoly
+  - Multi-rateSynchronizer
+  - FrameSynchronizer
 
 \section properties Properties
@@ -30 +33 @@
 \subsection prop_pulse_shape Pulse Shape
 CORBA::String
+  - "rrcos"
+  - "gaussian"
 
 \subsection prop_k Samples per Symbol

experimental/components/SymbolSyncPoly/src/SymbolSyncPolyDSP.cpp

@@ -78 +78 @@
     if ( strcmp(type, "rrcos")==0 ) {
         // square root raised-cosine
-        /// \todo implement derivative function in SigProc
         MF_i =  new SigProc::FIRPolyphaseFilterBank("rrcos", _k, _m, _beta, _Npfb);
         dMF_i = new SigProc::FIRPolyphaseFilterBank("drrcos", _k, _m, _beta, _Npfb);