mbeddr.core icon indicating copy to clipboard operation
mbeddr.core copied to clipboard

mbeddr.doc: DocumentationDescriptor cannot be resolved

Open arimer opened this issue 3 years ago • 2 comments

Adding a documenation aspect to your language and an empty Document http://127.0.0.1:63320/node?ref=r%3A5f7188a9-e7b4-4a2e-bef9-38d2cf379fdc%28com.mbeddr.doc.structure%29%2F3350625596579911728 leads to a compilation error.

It looks like the Document needs to at least reference one Concept of the structure model of the corresponding language to be able to compile successfully.

arimer avatar May 17 '21 07:05 arimer

To be a bit more precise: one needs to add a DocumentedConceptAnnotation to a section in order to make it have no compiler error. This can be done as follows:

  • Create a section
  • Stand on the section and invoke the Add reference to documented concept intention
  • Select a concept in the placeholder in the annotation above the intention that says Documents ...

I tested and it also works with the Add reference to documented property intention.

Thanks to @kbirken for the hints. Maybe it's good to have a look at this, since more people are getting into this "undocumented feature" of the doc language?

If it is not possible to solve the issue timely, maybe it would be possible to make a mitigation? A very simple improvement could be to simply put a document model into the documentation aspect upon its creation, with a section and in it the hint text "In order to prevent compiler errors, execute Add reference to documented concept/property on this section and point to a concept of the language to which this documentation aspect belongs".

eugenschindler avatar Jun 22 '21 18:06 eugenschindler

For making this piece of information better accessible to search engines: the error that you get in this specific situation is something along the lines of: [jetbrains.mps.make.CompilationErrorsHandler] MbeddrDocLangTest\Language.java : The import MbeddrDocLangTest.documentation.DocumentationDescriptor cannot be resolved
[jetbrains.mps.make.CompilationErrorsHandler] MbeddrDocLangTest\Language.java : DocumentationDescriptor cannot be resolved to a type

eugenschindler avatar Jun 24 '21 09:06 eugenschindler