Doc elements "about" imported model elements

Discussion
,
1

Hi,

This question tries to implement a library import solution given in an older post ( How to refer to external libraries? - #4 by Hormo ). I am trying to shift model documentation to a separate sysml file, as discussed here: Linking to model elements in doc element markdown strings

I have two files in `project-dir/models`: `mymeta.sysml` and `docs.sysml`.

# mymeta.sysml
library package mymeta {
  package myParts {
    part def MyBolt;
  }
}

# package docs {
  doc mydoc about mymeta
    /* documentation about the mymeta library package */
  

  doc anotherdoc about mymeta::myParts::MyBolt
    /* documentation about MyBolt */
}

I have taken care that the file names are the same as the root package names in each file, and that there is only one root package per file.

In `docs.sysml`, syside modeler does not seem to pick up `mymeta` in the line `doc mydoc about mymeta` as an imported object (there is no syntax highlighting showing it is imported, and there is no tooltip showing the import path). Syside Modeler also reports an error on the following comment line “Unexpected ‘REGULAR_COMMENT’, expected one of….".

`mymeta` is importable in `docs.sysml`. For example `part def M6 specializes mymeta::myParts::MyBolt;` works fine.

I also note that changing `doc` to `comment` works completely fine. Is it illegal to write `doc` elements “about” imported elements?

thanks

2

Yes, grammar does not allow using about on doc elements - docs always describe their enclosing element implicitly.

1 Like