addComment

Class: slreq.Link
Package: slreq

Add comments to links

Syntax

newComment = addComment(myLink,myComment)


Description

newComment = addComment(myLink,myComment) adds a comment, myComment, to the link myLink.

Input Arguments

myLink — Link

slreq.Link object

Link, specified as an slreq.Link object.

myComment — Comment text

string scalar | character vector

Comment text to add to the requirement, specified as a string scalar or character vector.

Output Arguments

newComment — New comment data

struct

New comment data, returned as a structure containing these fields:

CommentedBy — Name of individual or organization who added comment

character vector

Name of the individual or organization who added the comment, returned as a character vector.

CommentedOn — Date that comment was added

datetime

Date that the comment was added, returned as a datetime object.

CommentedRevision — Comment revision number

int32 object

Comment revision number, returned as an int32 object.

Text — Comment text

character vector

Comment text, returned as a character vector.

Examples

Add Comments to Links

Load the requirement set basicReqSet, which also loads the link set basicReqSet.slmx.

rs = slreq.load("basicReqSet");
myLinkSet = slreq.find(Type="LinkSet");

Get a handle to the link from the link set.

myLink = getLinks(myLinkSet);

Add a comment to the link.

newComment = addComment(myLink,"My new comment.");

Tips

• To add comments to requirements, use slreq.Requirement.addComment. To add comments to referenced requirements, use slreq.Reference.addComment. To add comments to justifications, use slreq.Justification.addComment.

Alternative Functionality

App

You can also add a comment by using the Requirements Editor. Select a link and, in the right pane, under Comments, click Add Comment.

Version History

Introduced in R2018a