More cleanup of doc

Signed-off-by: spagadar <[email protected]>
analogdevicesinc · Nov 1, 2024 · 78c6da5 · 78c6da5
1 parent 4f59762
commit 78c6da5
Show file tree

Hide file tree

Showing 12 changed files with 56 additions and 64 deletions.
diff --git a/bindings/c/include/cgenalyzer.h b/bindings/c/include/cgenalyzer.h
@@ -1,5 +1,5 @@
 /*
- * cgenalyzer_advanced - genalyzer (advanced) API header file
+ * cgenalyzer - genalyzer API header file
  *
  * Copyright (C) 2022 Analog Devices, Inc.
  * Author: Peter Derounian

diff --git a/bindings/c/include/cgenalyzer_simplified_beta.h b/bindings/c/include/cgenalyzer_simplified_beta.h
@@ -1,5 +1,5 @@
 /*
- * cgenalyzer - genalyzer API header file
+ * cgenalyzer - genalyzer (beta) simplified API header file
  *
  * Copyright (C) 2022 Analog Devices, Inc.
  * Author: Srikanth Pagadarai

diff --git a/bindings/matlab/genalyzer.m b/bindings/matlab/genalyzer.m
@@ -1,6 +1,6 @@
 classdef (Sealed) genalyzer < handle
     properties (Constant) % C Library Interface
-        header_name = 'cgenalyzer_advanced.h';
+        header_name = 'cgenalyzer.h';
         nixbin_name = 'libgenalyzer.so';
         winbin_name = 'libgenalyzer.dll';
         lib_alias = 'gn';

diff --git a/doc/gen_api_page.py b/doc/gen_api_page.py
@@ -76,7 +76,7 @@ def gen_pages():
     page += "- [Generate Functions](#generate-functions)\n"
     page += "- [Operation Functions](#operation-functions)\n\n"
 
-    page += "## Structs\n\n"
+    #page += "## Structs\n\n"
 
 
     def gen_functions(functions):

diff --git a/doc/python/enumerations.rst b/doc/python/enumerations.rst
@@ -1,22 +1,20 @@
 Enumerations
 ------------
 
-.. module:: genalyzer
+.. autofunction:: genalyzer.CodeFormat
 
-.. autofunction:: CodeFormat
+.. autofunction:: genalyzer.DnlSignal
 
-.. autofunction:: DnlSignal
+.. autofunction:: genalyzer.FaCompTag
 
-.. autofunction:: FaCompTag
+.. autofunction:: genalyzer.FaSsb
 
-.. autofunction:: FaSsb
+.. autofunction:: genalyzer.FreqAxisFormat
 
-.. autofunction:: FreqAxisFormat
+.. autofunction:: genalyzer.FreqAxisType
 
-.. autofunction:: FreqAxisType
+.. autofunction:: genalyzer.InlLineFit
 
-.. autofunction:: InlLineFit
+.. autofunction:: genalyzer.RfftScale
 
-.. autofunction:: RfftScale
-
-.. autofunction:: Window
+.. autofunction:: genalyzer.Window
diff --git a/doc/python/fourier_analysis.rst b/doc/python/fourier_analysis.rst
@@ -1,6 +1,4 @@
 Fourier Analysis
 ----------------
 
-.. module:: genalyzer
-
-.. autofunction:: fft_analysis
+.. autofunction:: genalyzer.fft_analysis
diff --git a/doc/python/fourier_configuration.rst b/doc/python/fourier_configuration.rst
@@ -1,54 +1,52 @@
 Fourier Analysis Configuration
 ------------------------------
-
-.. module:: genalyzer
 
-.. autofunction:: fa_analysis_band
+.. autofunction:: genalyzer.fa_analysis_band
 
-.. autofunction:: fa_clk
+.. autofunction:: genalyzer.fa_clk
 
-.. autofunction:: fa_conv_offset
+.. autofunction:: genalyzer.fa_conv_offset
 
-.. autofunction:: fa_create
+.. autofunction:: genalyzer.fa_create
 
-.. autofunction:: fa_dc
+.. autofunction:: genalyzer.fa_dc
 
-.. autofunction:: fa_fdata
+.. autofunction:: genalyzer.fa_fdata
 
-.. autofunction:: fa_fixed_tone
+.. autofunction:: genalyzer.fa_fixed_tone
 
-.. autofunction:: fa_fsample
+.. autofunction:: genalyzer.fa_fsample
 
-.. autofunction:: fa_fshift
+.. autofunction:: genalyzer.fa_fshift
 
-.. autofunction:: fa_fund_images
+.. autofunction:: genalyzer.fa_fund_images
 
-.. autofunction:: fa_hd
+.. autofunction:: genalyzer.fa_hd
 
-.. autofunction:: fa_ilv
+.. autofunction:: genalyzer.fa_ilv
 
-.. autofunction:: fa_imd
+.. autofunction:: genalyzer.fa_imd
 
-.. autofunction:: fa_load
+.. autofunction:: genalyzer.fa_load
 
-.. autofunction:: fa_max_tone
+.. autofunction:: genalyzer.fa_max_tone
 
-.. autofunction:: fa_preview
+.. autofunction:: genalyzer.fa_preview
 
-.. autofunction:: fa_quad_errors
+.. autofunction:: genalyzer.fa_quad_errors
 
-.. autofunction:: fa_remove_comp
+.. autofunction:: genalyzer.fa_remove_comp
 
-.. autofunction:: fa_reset
+.. autofunction:: genalyzer.fa_reset
 
-.. autofunction:: fa_ssb
+.. autofunction:: genalyzer.fa_ssb
 
-.. autofunction:: fa_ssb_dc
+.. autofunction:: genalyzer.fa_ssb_dc
 
-.. autofunction:: fa_ssb_def
+.. autofunction:: genalyzer.fa_ssb_def
 
-.. autofunction:: fa_ssb_wo
+.. autofunction:: genalyzer.fa_ssb_wo
 
-.. autofunction:: fa_var
+.. autofunction:: genalyzer.fa_var
 
-.. autofunction:: fa_wo
+.. autofunction:: genalyzer.fa_wo
diff --git a/doc/python/fourier_transforms.rst b/doc/python/fourier_transforms.rst
@@ -1,7 +1,6 @@
 Fourier Transforms
 ------------------
-.. module:: genalyzer
 
-.. autofunction:: fft
+.. autofunction:: genalyzer.fft
 
-.. autofunction:: rfft
+.. autofunction:: genalyzer.rfft
diff --git a/doc/python/signal_processing.rst b/doc/python/signal_processing.rst
@@ -1,18 +1,18 @@
 Signal Processing
 -----------------
 
-.. module:: genalyzer
+.. autofunction:: genalyzer.downsample
 
-.. autofunction:: downsample
+.. autofunction:: genalyzer.fshift
 
-.. autofunction:: fshift
+.. autofunction:: genalyzer.normalize
 
-.. autofunction:: normalize
+.. autofunction:: genalyzer.polyval
 
-.. autofunction:: polyval
+.. autofunction:: genalyzer.quantize16
 
-.. autofunction:: quantize16
+.. autofunction:: genalyzer.quantize32
 
-.. autofunction:: quantize32
+.. autofunction:: genalyzer.quantize64
 
-.. autofunction:: quantize64
+.. autofunction:: genalyzer.quantize
diff --git a/doc/python/waveforms.rst b/doc/python/waveforms.rst
@@ -1,14 +1,12 @@
 Waveforms
 ---------
 
-.. module:: genalyzer
+.. autofunction:: genalyzer.cos
 
-   .. autofunction:: cos
+.. autofunction:: genalyzer.gaussian
 
-   .. autofunction:: gaussian
+.. autofunction:: genalyzer.ramp
 
-   .. autofunction:: ramp
+.. autofunction:: genalyzer.sin
 
-   .. autofunction:: sin
-
-   .. autofunction:: wf_analysis
+.. autofunction:: genalyzer.wf_analysis
diff --git a/doc/reference.md b/doc/reference.md
@@ -12,6 +12,7 @@ Advanced API Reference for Genalyzer library. This API is meant for advanced use
 
 ```{eval-rst}
 .. doxygengroup:: Enumerations
+   :no-link: 
 ```
 
 ## API Utilities

diff --git a/libgenalyzer.iss.cmakein b/libgenalyzer.iss.cmakein
@@ -45,7 +45,7 @@ Source: "D:\a\genalyzer\genalyzer\bindings\c\src\Release\libgenalyzer.lib"; Dest
 Source: "D:\a\genalyzer\genalyzer\src\Release\genalyzer_plus_plus.lib"; DestDir: "{sys}"; Check: Is64BitInstallMode; Flags: replacesameversion
 
 Source: "D:\a\genalyzer\genalyzer\bindings\c\include\cgenalyzer_simplified_beta.h"; DestDir: "{commonpf32}\Microsoft Visual Studio 12.0\VC\include"
-Source: "D:\a\genalyzer\genalyzer\bindings\c\include\cgenalyzer_advanced.h"; DestDir: "{commonpf32}\Microsoft Visual Studio 12.0\VC\include"
+Source: "D:\a\genalyzer\genalyzer\bindings\c\include\cgenalyzer.h"; DestDir: "{commonpf32}\Microsoft Visual Studio 12.0\VC\include"
 
 Source: "D:\a\genalyzer\genalyzer\deps\fftw3\libfftw3-3.dll"; DestDir: "{sys}"; Check: Is64BitInstallMode