Skip to content

Documentation template for class Trajectory#64

Open
Daniel-Tojal wants to merge 26 commits intoadhusch:developfrom
Daniel-Tojal:docs-classes-Trajectory
Open

Documentation template for class Trajectory#64
Daniel-Tojal wants to merge 26 commits intoadhusch:developfrom
Daniel-Tojal:docs-classes-Trajectory

Conversation

@Daniel-Tojal
Copy link
Contributor

No description provided.

% University of Luxembourg - Luxembourg Centre for Systems Biomedicne
% 2013 - 2017
% mail@andreashusch.de
classdef Trajectory < handle & matlab.mixin.Copyable & MetaTrajectory
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@adhusch , could you please have a look through the file and check if everything has been properly documented with the right descriptions?

@Daniel-Tojal Daniel-Tojal changed the base branch from master to develop May 25, 2019 09:53
@laurentheirendt laurentheirendt requested a review from adhusch May 25, 2019 19:12
Copy link
Owner

@adhusch adhusch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer to not comment self-explanatory standard getters and setters at all. E.g.:

function value = getTargetPoint(this)
	        % Function that gets the coordinates of the target point
	        %
	        % Parameters:
	        %
	        %    this:      Self-Reference
	        %
	        % Returns:
	        %
	        %    value:     Target point coordinates.
	
	          value = this.targetPoint3D.point;
end

The comment adds zero information but blows up the code and decreases readability.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants