Skip to content

Commit

Permalink
small fixes for doxygen in preparation of release
Browse files Browse the repository at this point in the history
  • Loading branch information
PetePupalaikis committed Jun 11, 2020
1 parent 6b7285f commit dfe35c8
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion SignalIntegrity/Lib/Parsers/SystemDescriptionParser.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion SignalIntegrity/Lib/SystemDescriptions/Numeric.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion SignalIntegrity/Lib/TimeDomain/Waveform/PulseWaveform.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit dfe35c8

Please sign in to comment.