Opened 7 years ago

Closed 7 years ago

#4642 closed defect (fixed)

Add documentation of __OpenModelica vendor annotations for compilation and simulation flags

Reported by: Francesco Casella Owned by: Adeel Asghar
Priority: high Milestone: 1.13.0
Component: Documentation Version:
Keywords: Cc:

Description (last modified by Francesco Casella)

Following the discussion in #3488, vendor-specific annotations were added in OMC to set compilation and simulation flags.

Unfortunately, there is no mention of them in the user's guide, the only references are found in the ticket:

where they are mixed up with early proposals and various discussions, which makes the whole thing quite hard to interpret.

I would recommend to add a reference to the first two in the Compiler Flags page and a reference to the second two in the Simulation Flags page, explaining how to set the flags and with at least one example with multiple flags to make it clearer.

Also, it is not clear how (or actually if) it is possible to set value-less flags such as -daeMode or -noEquidistantTimeGrid, as it seems from the examples given in #3488 that is only possible to set simflags that have a value.

Change History (4)

comment:1 by Francesco Casella, 7 years ago

Description: modified (diff)

comment:2 by Francesco Casella, 7 years ago

Maybe it would be betteer to add a section with all these annotations in the Documentation after Small Overview of Simulation Flags

comment:3 by anonymous, 7 years ago

Please also add documentation of the followign flag:

annotation(__OpenModelica_IgnoreReplaceable)

https://trac.openmodelica.org/OpenModelica/ticket/4648

comment:4 by Francesco Casella, 7 years ago

Resolution: fixed
Status: newclosed
Note: See TracTickets for help on using tickets.