Documentation template for class SimpleFieldSim3D#66
Documentation template for class SimpleFieldSim3D#66Daniel-Tojal wants to merge 14 commits intoadhusch:developfrom
Conversation
Daniel-Tojal
changed the title
| % | ||
| % Returns: | ||
| % | ||
| % graphicsHandle: |
There was a problem hiding this comment.
@adhusch , Could you please provide a description of the graphicsHandle? Also could you check if the existing descriptions are correct?
There was a problem hiding this comment.
I personally dont like this:
impedance = 800; % Resistance given in [Ohm]
voltage = 1.0; % Voltage given in [V]
When a variable name is completly descriptive the additional comment of exactly the same is redundant noise. I would leave it as
impedance = 800; %[Ohm]
voltage = 1.0; %[V]
There was a problem hiding this comment.
Alright, thanks, i'll keep this in mind for future PRs
| % | ||
| % Returns: | ||
| % | ||
| % graphicsHandle: |
There was a problem hiding this comment.
I personally dont like this:
impedance = 800; % Resistance given in [Ohm]
voltage = 1.0; % Voltage given in [V]
When a variable name is completly descriptive the additional comment of exactly the same is redundant noise. I would leave it as
impedance = 800; %[Ohm]
voltage = 1.0; %[V]
src/Classes/SimpleFieldSim3D.m
Outdated
|
|
||
| methods | ||
| function this = SimpleFieldSim3D(trajectoryObject) | ||
| % Function that serves to initialize a normalized sphere |
src/Classes/SimpleFieldSim3D.m
Outdated
| % | ||
| % Parameters: | ||
| % | ||
| % impedance: Resistance of the electrodes. |
There was a problem hiding this comment.
impedance: assumed electrical impedance of the tissue
src/Classes/SimpleFieldSim3D.m
Outdated
| % Parameters: | ||
| % | ||
| % impedance: Resistance of the electrodes. | ||
| % voltage: Voltage between the electrodes. |
There was a problem hiding this comment.
voltage: monopolar stimulation voltage
| % Parameters: | ||
| % | ||
| % this: Self-Reference | ||
| % ax: |
There was a problem hiding this comment.
@adhusch Could you please provide a description for ax and graphicsHandle?
2 participants
No description provided.