+
+
+
+ Copyright (C) Kevin Larke 2009-2020
+
+
+
+ This file is part of libcm.
+
+
+
+ libcm is free software: you can redistribute it and/or modify it under
+ the terms of the GNU General Public License as published by the Free
+ Software Foundation, either version 3 of the License, or (at your
+ option) any later version.
+
+
+
+ libcm is distributed in the hope that it will be useful, but WITHOUT
+ ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ for more details.
+
+
+
+ See the GNU General Public License distributed with the libcm
+ package or look here: .
+
+
+
+
+
+
diff --git a/doc/cdg_div_cod.css b/doc/cdg_div_cod.css
deleted file mode 100644
index bff2ba6..0000000
--- a/doc/cdg_div_cod.css
+++ /dev/null
@@ -1,24 +0,0 @@
-
-
-.cod pre .c { color: firebrick; font-weight: normal; } /* Comment */
-.cod pre .k { color: #008000; font-weight: normal; } /* Keyword.Reserved */
-.cod pre .p { color: #666666 } /* Operator */
-.cod pre .f { color: #000000; font-weight: normal; } /* Function */
-.cod pre .e { color: #000000; font-weight: normal; } /* enum */
-.cod pre .m { color: #008000; font-weight: normal; } /* macro */
-.cod pre .t { color: #008000; font-weight: normal; } /* typedef */
-.cod pre .i { color: #000000; font-weight: normal; } /* ident */
-.cod pre .l { color: #660066 } /* Literal */
-.cod pre .u { color: #000000 }
-
-.cod pre a:link {text-decoration:none; font-weight:500; }
-.cod pre a:visited {text-decoration:none; font-weight:500; }
-.cod pre a:hover {text-decoration:none; font-weight:700; }
-
-/* embedded pandoc comments */
-.cod pre .a {
- border: 1px dotted gray;
- background-color: #ececec;
- color: #1111111;
- padding: 0.5em;
-}
diff --git a/doc/gen_doc.sh b/doc/gen_doc.sh
index c126948..fc8a83e 100755
--- a/doc/gen_doc.sh
+++ b/doc/gen_doc.sh
@@ -14,7 +14,6 @@ gcc -E -C -P -traditional-cpp -o temp.h ../src/vop/cmVectOpsDoc.h
sed 's/\(_##\)/_/g' temp.h > temp1.h
# Remove header text generated by gcc.
-# sed '/\/\*/,/\/\/end_cut/{#!d}' temp.h
sed '/\/\*/,/\/\/end_cut/{//!d;};' temp1.h > temp2.h
# Remove the first two lines.
@@ -25,4 +24,9 @@ rm -f temp1.h
rm -f temp2.h
# Run the doc generator
-#cdg -c cdg_cfg.json -o ~/temp/doc_libcm
+# Note that we must use a full path to the 'cdg_cfg.json' file because it's
+# absolute location must be determined to locate the full path to the source files.
+~/src/dc/build/linux/debug/bin/cdg -c ~/src/libcm/doc/cdg_cfg.json -o ~/temp/doc2
+
+#
+scp ~/temp/doc2/* wf:webapps/currawongproject/htdocs/static/doc/libcm
diff --git a/src/cmJson.c b/src/cmJson.c
index 09e9ba7..0183870 100644
--- a/src/cmJson.c
+++ b/src/cmJson.c
@@ -3992,13 +3992,11 @@ void _cmJsonTestPrint( void* userPtr, const cmChar_t* text )
}
-//{ { label:cmJsonEx }
-//(
+//( { label:cmJsonEx }
+//
// cmJsonTest() demonstrates some JSON tree operations.
-//)
-
-//(
-cmJsRC_t cmJsonTest( const char* fn, cmCtx_t* ctx )
+//
+JsRC_t cmJsonTest( const char* fn, cmCtx_t* ctx )
{
cmJsRC_t rc = kOkJsRC;
cmJsRC_t rc1 = kOkJsRC;
@@ -4080,4 +4078,3 @@ cmJsRC_t cmJsonTest( const char* fn, cmCtx_t* ctx )
return rc == kOkJsRC ? rc1 : rc;
}
//)
-//}
diff --git a/src/cmLex.c b/src/cmLex.c
index 72fc480..776675f 100644
--- a/src/cmLex.c
+++ b/src/cmLex.c
@@ -909,12 +909,10 @@ const cmChar_t* cmLexRcToMsg( unsigned rc )
}
-//{ { label:cmLexEx }
-//(
+//( { label:cmLexEx }
+//
// cmLexTest() gives a simple cmLex example.
-//)
-
-//(
+//
void cmLexTest( cmRpt_t* rpt)
{
cmChar_t buf[] =
@@ -983,4 +981,3 @@ void cmLexTest( cmRpt_t* rpt)
}
//)
-//}
diff --git a/src/cmSerialize.c b/src/cmSerialize.c
index 7a0f2c6..2e53b85 100644
--- a/src/cmSerialize.c
+++ b/src/cmSerialize.c
@@ -1573,13 +1573,10 @@ const bool* cmSrRdBoolCV( cmSrH_t h, unsigned* eleCntPtr)
return cmSrReadBoolCV(h,&valPtr,eleCntPtr) == kOkSrRC ? valPtr : NULL;
}
-//{ { label:cmSerialEx }
-//(
-// cmSrTest() is a serializer example function.
-//)
-//[
-
+//
+// cmSrTest() is a serializer example function.
+//
cmSrRC_t cmSrTest( cmCtx_t* ctx )
{
unsigned i,j,k;
@@ -1723,5 +1720,4 @@ cmSrRC_t cmSrTest( cmCtx_t* ctx )
return rc;
}
-//]
-//}
+
diff --git a/src/cmSymTbl.c b/src/cmSymTbl.c
index 78faf46..53652ca 100644
--- a/src/cmSymTbl.c
+++ b/src/cmSymTbl.c
@@ -352,12 +352,11 @@ void cmSymTblReport( cmSymTblH_t h )
}
-//{ { label:cmSymTblEx }
-//(
+//( { label:cmSymTblEx }
+//
// cmSymTblTest() gives a usage example for the symbol table component.
-//)
+//
-//[
void cmSymTblTest( cmCtx_t* ctx )
{
unsigned baseSymId = 100;
@@ -405,5 +404,4 @@ void cmSymTblTest( cmCtx_t* ctx )
return;
}
-//]
-//}
+//)
diff --git a/src/cmVectOpsDocOut.h b/src/cmVectOpsDocOut.h
index 71d05b2..a269402 100644
--- a/src/cmVectOpsDocOut.h
+++ b/src/cmVectOpsDocOut.h
@@ -1,7 +1,7 @@
-//| Copyright: (C) 2009-2020 Kevin Larke
-//| License: GNU GPL version 3.0 or above. See the accompanying LICENSE file.
//( { file_desc:"Math vector operations." kw:[vop math] }
//)
+//| Copyright: (C) 2009-2020 Kevin Larke
+//| License: GNU GPL version 3.0 or above. See the accompanying LICENSE file.
//( { label:misc desc:"Miscellaneous vector operations." kw:[vop] }
// Compute the cummulative sum of sbp[dn]. Equivalent to Matlab cumsum().
@@ -719,6 +719,8 @@ void cmVOT_Interp1(T_t* y1, const T_t* x1, unsigned xy1N, const T_t* x0, const T
//======================================================================================================================
//)
+//| Copyright: (C) 2009-2020 Kevin Larke
+//| License: GNU GPL version 3.0 or above. See the accompanying LICENSE file.
//( { label:"Matrix ops" desc:"Common 2D matrix operations and accessors." kw:[vop] }
diff --git a/src/dsp/cmDspBuiltIn.c b/src/dsp/cmDspBuiltIn.c
index 11788f1..dc48465 100644
--- a/src/dsp/cmDspBuiltIn.c
+++ b/src/dsp/cmDspBuiltIn.c
@@ -54,6 +54,7 @@
//------------------------------------------------------------------------------------------------------------
//)
+
//( { label:cmDspPrinter file_desc:"Console printing unit." kw:[sunit] }
enum
{
diff --git a/src/dsp/cmDspKr.c b/src/dsp/cmDspKr.c
index 7832e4c..beae8aa 100644
--- a/src/dsp/cmDspKr.c
+++ b/src/dsp/cmDspKr.c
@@ -53,7 +53,8 @@
//------------------------------------------------------------------------------------------------------------
//)
-//( { label:cmDspKr file_desc:"Spectral non-linear distortion effect." kw:[sunit] }
+
+//( { label:cmDspKr file_desc:"Spectral non-linear distortion effect." kw:[sunit gutim] }
enum
{
@@ -287,7 +288,7 @@ cmDspClass_t* cmKrClassCons( cmDspCtx_t* ctx )
//------------------------------------------------------------------------------------------------------------
//)
-//( { label:cmDspKr2 file_desc:"Spectral non-linear distortion effect." kw:[sunit] }
+//( { label:cmDspKr2 file_desc:"Spectral non-linear distortion effect." kw:[sunit gutim] }
enum
{
@@ -544,7 +545,7 @@ cmDspClass_t* cmKr2ClassCons( cmDspCtx_t* ctx )
//------------------------------------------------------------------------------------------------------------
//)
-//( { label:cmDspTimeLine file_desc:"Time line user interface unit." kw:[sunit] }
+//( { label:cmDspTimeLine file_desc:"Time line user interface unit." kw:[sunit gutim] }
enum
{
@@ -734,7 +735,7 @@ cmDspClass_t* cmTimeLineClassCons( cmDspCtx_t* ctx )
//------------------------------------------------------------------------------------------------------------
//)
-//( { label:cmDspScore file_desc:"Musical score user interface unit." kw:[sunit] }
+//( { label:cmDspScore file_desc:"Musical score user interface unit." kw:[sunit gutim] }
enum
{
@@ -931,7 +932,7 @@ cmDspClass_t* cmScoreClassCons( cmDspCtx_t* ctx )
//------------------------------------------------------------------------------------------------------------
//)
-//( { label:cmDspMidiFilePlay file_desc:"MIDI file player." kw:[sunit] }
+//( { label:cmDspMidiFilePlay file_desc:"MIDI file player." kw:[sunit gutim] }
enum
{
@@ -1173,7 +1174,7 @@ cmDspClass_t* cmMidiFilePlayClassCons( cmDspCtx_t* ctx )
//------------------------------------------------------------------------------------------------------------
//)
-//( { label:cmDspScFol file_desc:"MIDI performance score follower." kw:[sunit] }
+//( { label:cmDspScFol file_desc:"MIDI performance score follower." kw:[sunit gutim] }
enum
{
@@ -1491,7 +1492,7 @@ cmDspClass_t* cmScFolClassCons( cmDspCtx_t* ctx )
//------------------------------------------------------------------------------------------------------------
//)
-//( { label:cmDspScMod file_desc:"Score driven parameter automation." kw:[sunit] }
+//( { label:cmDspScMod file_desc:"Score driven parameter automation." kw:[sunit gutim] }
enum
{
@@ -1721,7 +1722,7 @@ cmDspClass_t* cmScModClassCons( cmDspCtx_t* ctx )
//------------------------------------------------------------------------------------------------------------
//)
-//( { label:cmDspGSwitch file_desc:"Route all inputs to one of a group of outputs." kw:[sunit] }
+//( { label:cmDspGSwitch file_desc:"Route all inputs to one of a group of outputs." kw:[sunit gutim] }
enum
{
@@ -1922,7 +1923,7 @@ cmDspClass_t* cmGSwitchClassCons( cmDspCtx_t* ctx )
//------------------------------------------------------------------------------------------------------------
//)
-//( { label:cmDspScaleRange file_desc:"Offset and scale a scalar value." kw:[sunit] }
+//( { label:cmDspScaleRange file_desc:"Offset and scale a scalar value." kw:[sunit gutim] }
enum
{
@@ -2025,7 +2026,7 @@ cmDspClass_t* cmScaleRangeClassCons( cmDspCtx_t* ctx )
//------------------------------------------------------------------------------------------------------------
//)
-//( { label:cmDspActiveMeas file_desc:"Issue stored parameter values at specified score locations." kw:[sunit] }
+//( { label:cmDspActiveMeas file_desc:"Issue stored parameter values at specified score locations." kw:[sunit gutim] }
enum
{
@@ -2412,7 +2413,7 @@ cmDspClass_t* cmActiveMeasClassCons( cmDspCtx_t* ctx )
//------------------------------------------------------------------------------------------------------------
//)
-//( { label:cmDspAmSync file_desc:"Calculate MIDI to Audio latency offsets." kw:[sunit] }
+//( { label:cmDspAmSync file_desc:"Calculate MIDI to Audio latency offsets." kw:[sunit gutim] }
//
//
// Usage:
@@ -2690,7 +2691,7 @@ cmDspClass_t* cmAmSyncClassCons( cmDspCtx_t* ctx )
//------------------------------------------------------------------------------------------------------------
//)
-//( { label:cmDspNanoMap file_desc:"Control a MIDI synth." kw:[sunit] }
+//( { label:cmDspNanoMap file_desc:"Control a MIDI synth." kw:[sunit gutim] }
enum
{
@@ -2818,7 +2819,7 @@ cmDspClass_t* cmNanoMapClassCons( cmDspCtx_t* ctx )
//------------------------------------------------------------------------------------------------------------
//)
-//( { label:cmDspPicadae file_desc:"Control a MIDI synth." kw:[sunit] }
+//( { label:cmDspPicadae file_desc:"Control the Picadae piano mechanism." kw:[sunit gutim] }
enum
{
@@ -3253,7 +3254,7 @@ cmDspClass_t* cmPicadaeClassCons( cmDspCtx_t* ctx )
//------------------------------------------------------------------------------------------------------------
//)
-//( { label:cmDspRecdPlay file_desc:"Record audio segments from a live perfromance and play them back at a later time" kw:[sunit] }
+//( { label:cmDspRecdPlay file_desc:"Record audio segments from a live perfromance and play them back at a later time" kw:[sunit gutim] }
enum
{
@@ -3632,7 +3633,7 @@ cmDspClass_t* cmRecdPlayClassCons( cmDspCtx_t* ctx )
//------------------------------------------------------------------------------------------------------------
//)
-//( { label:cmDspGoertzel file_desc:"Goertzel tone detection filter" kw:[sunit] }
+//( { label:cmDspGoertzel file_desc:"Goertzel tone detection filter" kw:[sunit gutim] }
enum
{
kHopFactGrId,
@@ -3809,7 +3810,7 @@ cmDspClass_t* cmGoertzelClassCons( cmDspCtx_t* ctx )
//------------------------------------------------------------------------------------------------------------
//)
-//( { label:cmDspSyncRecd file_desc:"Time align a MIDI and associated audio recording" kw:[sunit] }
+//( { label:cmDspSyncRecd file_desc:"Time align a MIDI and associated audio recording" kw:[sunit gutim] }
enum
{
@@ -4014,7 +4015,7 @@ cmDspClass_t* cmSyncRecdClassCons( cmDspCtx_t* ctx )
//------------------------------------------------------------------------------------------------------------
//)
-//( { label:cmDspTakeSeqBldr file_desc:"User interface unit for creating a single sequence from multiple, score aligned, MIDI fragments." kw:[sunit] }
+//( { label:cmDspTakeSeqBldr file_desc:"User interface unit for creating a single sequence from multiple, score aligned, MIDI fragments." kw:[sunit gutim] }
enum
{
@@ -4148,7 +4149,7 @@ cmDspClass_t* cmTakeSeqBldrClassCons( cmDspCtx_t* ctx )
//------------------------------------------------------------------------------------------------------------
//)
-//( { label:cmDspTakeSeqRend file_desc:"User interface unit for graphically rendering the MIDI sequences created by cmDspTakeSeqBldr." kw:[sunit] }
+//( { label:cmDspTakeSeqRend file_desc:"User interface unit for graphically rendering the MIDI sequences created by cmDspTakeSeqBldr." kw:[sunit gutim] }
enum
{
kBldrTsrId,
@@ -4369,7 +4370,7 @@ cmDspClass_t* cmTakeSeqRendClassCons( cmDspCtx_t* ctx )
//------------------------------------------------------------------------------------------------------------
//)
-//( { label:cmDspReflectCalc file_desc:"Estimate the time-of-flight of from an acoustic signal from a speaker to a microphone." kw:[sunit] }
+//( { label:cmDspReflectCalc file_desc:"Estimate the time-of-flight of from an acoustic signal from a speaker to a microphone." kw:[sunit gutim] }
enum
{
kLfsrN_RcId,
@@ -4527,7 +4528,7 @@ cmDspClass_t* cmReflectCalcClassCons( cmDspCtx_t* ctx )
//------------------------------------------------------------------------------------------------------------
//)
-//( { label:cmDspEchoCancel file_desc:"Normalized least mean squares echo canceller." kw:[sunit] }
+//( { label:cmDspEchoCancel file_desc:"Normalized least mean squares echo canceller." kw:[sunit gutim] }
enum
{
kMuEcId,
diff --git a/src/dsp/cmDspKr.h b/src/dsp/cmDspKr.h
index 476fa83..ec9849b 100644
--- a/src/dsp/cmDspKr.h
+++ b/src/dsp/cmDspKr.h
@@ -7,6 +7,8 @@
extern "C" {
#endif
+ //( { file_desc:"Dataflow process interface developed for GUTIM." kw:[snap gutim] }
+
struct cmDspClass_str* cmKrClassCons( cmDspCtx_t* ctx );
struct cmDspClass_str* cmKr2ClassCons( cmDspCtx_t* ctx );
struct cmDspClass_str* cmTimeLineClassCons( cmDspCtx_t* ctx );
@@ -27,7 +29,9 @@ extern "C" {
struct cmDspClass_str* cmTakeSeqRendClassCons( cmDspCtx_t* ctx );
struct cmDspClass_str* cmReflectCalcClassCons( cmDspCtx_t* ctx );
struct cmDspClass_str* cmEchoCancelClassCons( cmDspCtx_t* ctx );
-
+
+ //)
+
#ifdef __cplusplus
}
#endif