addComment

Class: slreq.Justification
Package: slreq

Add comments to justifications

Since R2018b

Syntax

newComment = addComment(jt,myComment)


Description

newComment = addComment(jt,myComment) adds a comment, myComment, to the justification jt.

Input Arguments

jt — Justification

slreq.Justification object

Justification, specified as an slreq.Justification 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 Justifications

This example shows how to add comments to justifications.

Load the requirement set crs_req_justs.

rs = slreq.load("crs_req_justs");

Get a handle to the first justification in the requirement set.

jt = find(rs,Index=5);

Add a comment to the justification.

newComment = addComment(jt,"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 links, use slreq.Link.addComment.

Alternative Functionality

App

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

Version History

Introduced in R2018b