allow setting startType for documenting realizations

[fbenke-pik]

Motivation:

Currently, all gms files in realizations of REMIND are prepended with the equations identifier, which results in automatic inclusion of comments and equations in the goxygen documentation. This implicit approach has led to confusion among REMIND developers. In REMIND, we only want to include equations when stated explicitly by the equations identifier.

Therefore, we would like allow passing the parameter startType for documenting realizations when calling goxygen (defaults to "equations", which means current behavior). For REMIND, we will simply set it to NULL.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (8cf529f) 93.89% compared to head (daefb43) 93.89%.

Additional details and impacted files

@@           Coverage Diff           @@
##           master      #28   +/-   ##
=======================================
  Coverage   93.89%   93.89%           
=======================================
  Files          19       19           
  Lines         753      754    +1     
=======================================
+ Hits          707      708    +1     
  Misses         46       46           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[tscheypidi]

I think it would be more flexible and perhaps also more intuitive if you would just pass through the start_type argument. Ìn that case start_type = NULL would offer the wanted behavior.

If you agree with this solution it might also make sense to apply our camelcase linter rule and rename start_type to startType. If I am not mistaken that should still be possible at this stage without running into bigger compatibility issues as goxygen is usally the function which is being called externally.

[fbenke-pik]

@tscheypidi I have made the requested adjustment. Please take a look again.

[tscheypidi]

looks good, thanks!