addComment

Class: slreq.Reference
Package: slreq

Add comments to referenced requirements

Syntax

newComment = addComment(ref,myComment)


Description

newComment = addComment(ref,myComment) adds a comment, myComment, to the referenced requirement ref.

Input Arguments

ref — Referenced requirement

slreq.Reference object

Referenced requirement, specified as a slreq.Reference 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 Referenced Requirements

This example shows how to add comments to referenced requirements.

Load the requirement set crs_req.

rs = slreq.load("crs_req");

Find the first referenced requirement in the set.

ref = find(rs,Index=1);

Add a comment to the referenced requirement.

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

Tips

• To add comments to requirements, use slreq.Requirement.addComment. To add comments to justifications, use slreq.Justification.addComment. To add comments to links, use slreq.Link.addComment.

Alternative Functionality

App

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

Version History

Introduced in R2018b