Documentation Field API

[mrlevy@mitre.org]

Hello,

I am trying currently iterating over a block diagram and trying to extract the documentation field for each component. Currently I am able to extract part values, but have not found any API for extracting the documentation.
Is this a supported API feature or will I need to do a workaround of using a string part value for a custom description field for each block?

Thank you

[yu3333]

To get the documentation, we can do it this way:

Code: Select all

Element block = ... ;
Collection<Comment> comments = block.getOwnedComment();
    if(comments != null) {
        for (Comment comment : comments) {
            if (comment.getBody() != null) {
                print(comment.getBody());        //    comment.getBody() is the documentation we need   
            }
        }
    }