From dfe35c8a6aab0f7d60fa18978be02f5d19625a4a Mon Sep 17 00:00:00 2001 From: PetePupalaikis Date: Thu, 11 Jun 2020 12:58:48 -0400 Subject: [PATCH] small fixes for doxygen in preparation of release --- .../Lib/Parsers/NetworkAnalyzerSimulationNumericParser.py | 2 +- SignalIntegrity/Lib/Parsers/SystemDescriptionParser.py | 2 +- SignalIntegrity/Lib/SystemDescriptions/Numeric.py | 2 +- SignalIntegrity/Lib/TimeDomain/Waveform/PulseWaveform.py | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/SignalIntegrity/Lib/Parsers/NetworkAnalyzerSimulationNumericParser.py b/SignalIntegrity/Lib/Parsers/NetworkAnalyzerSimulationNumericParser.py index ce1dc590d..02b55e293 100644 --- a/SignalIntegrity/Lib/Parsers/NetworkAnalyzerSimulationNumericParser.py +++ b/SignalIntegrity/Lib/Parsers/NetworkAnalyzerSimulationNumericParser.py @@ -50,7 +50,7 @@ def __init__(self, f=None, DUTSParameters=None, PortConnectionList=None ,args=No SimulatorNumericParser.__init__(self,f,args,callback,cacheFileName) def HashValue(self,stuffToHash=''): """Generates the hash for a definition - It is formed by hashing the port connection with whatever else is hashed.. + It is formed by hashing the port connection with whatever else is hashed @param stuffToHash repr of stuff to hash @remark derived classes should override this method and call the base class HashValue with their stuff added @return integer hash value diff --git a/SignalIntegrity/Lib/Parsers/SystemDescriptionParser.py b/SignalIntegrity/Lib/Parsers/SystemDescriptionParser.py index 63c676d8c..14e288f7f 100644 --- a/SignalIntegrity/Lib/Parsers/SystemDescriptionParser.py +++ b/SignalIntegrity/Lib/Parsers/SystemDescriptionParser.py @@ -31,7 +31,7 @@ def __init__(self,f=None,args=None): """Constructor frequencies may be provided at construction time (or not for symbolic solutions). @param f (optional) list of frequencies - @param args (optional) string arguments for the circuit. + @param args (optional) string arguments for the circuit. @remark Arguments are provided on a line as pairs of names and values separated by a space. """ self.m_sd = None diff --git a/SignalIntegrity/Lib/SystemDescriptions/Numeric.py b/SignalIntegrity/Lib/SystemDescriptions/Numeric.py index f384f71b2..11223749f 100644 --- a/SignalIntegrity/Lib/SystemDescriptions/Numeric.py +++ b/SignalIntegrity/Lib/SystemDescriptions/Numeric.py @@ -164,7 +164,7 @@ def Dagger(self,A,Left=None,Right=None,Mul=False): raise LinAlgError def PermutationMatrix(self,rowList,Elements): """Row permutation matrix - @param list of integer row elements to extract from matrix to right - in order + @param rowList list of integer row elements to extract from matrix to right - in order @param Elements integer number of elements in matrix to right @return Row permutation matrix that if multiplied by matrix to the right, extracts the rows in rowList diff --git a/SignalIntegrity/Lib/TimeDomain/Waveform/PulseWaveform.py b/SignalIntegrity/Lib/TimeDomain/Waveform/PulseWaveform.py index 1c486e676..b10c9e585 100644 --- a/SignalIntegrity/Lib/TimeDomain/Waveform/PulseWaveform.py +++ b/SignalIntegrity/Lib/TimeDomain/Waveform/PulseWaveform.py @@ -30,7 +30,7 @@ def __init__(self,td,Amplitude=1.,StartTime=0.,PulseWidth=0.,Risetime=0.): @param Amplitude (optional) float amplitude of pulse (defaults to unity). @param StartTime (optional) float starting time of the pulse (defaults to zero). @param PulseWidth (optional) float the width of the pulse (defaults to zero). - @param risetime (optional) float risetime in seconds (defaults to 0.) + @param Risetime (optional) float risetime in seconds (defaults to 0.) @note The amplitude can be positive or negative, with negative providing a negative pulse. @note if the pulse appears entirely within the samples, then the waveform will be all zero.