Main Content

addComment

Class: slreq.Reference
Package: slreq

Add comments to referenced requirements

Syntax

newComment = addComment(myRef, 'myComment')

Description

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

Input Arguments

expand all

The referenced requirement to which you add a comment to, specified as an slreq.Reference object.

Output Arguments

expand all

Comment added to the referenced requirement, returned as a structure containing these fields.

The name of the individual or organization who commented on the referenced requirement, returned as a character vector.

The date on which the comment was added to the referenced requirement, returned as a datetime value.

Referenced requirement comment revision number, specified as a scalar.

The text of the added comment, returned as a character vector.

Examples

Add a Comment to a Referenced Requirement

myComment = addComment(myRef, 'New comment')

myComment = 

  struct with fields:

          CommentedBy: 'Jane Doe'
          CommentedOn: 21-Dec-2018 13:39:11
    CommentedRevision: 1
                 Text: 'New comment'

See Also

Introduced in R2019a