[Wanted feature] Handle @start/@end syntax error better

[The-Lum]

[Inspired by #1519]

Now that @startuml/@enduml is not the only one possible @startX/@endX.

• Could you handle @start/@end syntax error better?

Hints of possible code change:

• plantuml/src/net/sourceforge/plantuml/SourceStringReader.java

  Line 157 in 8172f94

  noStartumlFound(os, fileFormatOption);

• plantuml/src/net/sourceforge/plantuml/SourceStringReader.java

  Line 233 in 8172f94

  public ImageData noStartumlFound(OutputStream os, FileFormatOption fileFormatOption) throws IOException {

I can help on that, by proposing a PR...
Regards,
Th.

[The-Lum]

Open question @arnaudroques, and PlantUML team:

• It seems that checkSyntax function is never use?:
  

  plantuml/src/net/sourceforge/plantuml/syntax/SyntaxChecker.java

  Line 66 in 8172f94

  public static SyntaxResult checkSyntax(String source) {

• Could you confirm? [I get lost with dead code]
  [maybe we could just keep dead code in the making, by tagging 'for future use'..., or just 'old [dead] code, just for archive']

Reagrds,
Th.

[arnaudroques]

• [maybe we could just keep dead code in the making, by tagging 'for future use'..., or just 'old [dead] code, just for archive']

Yes sorry about that.
So there is now a new DeadCode annotation to clearly show unused code.

Theoretically, we could remove this dead code. However, we could like to keep a trace of it, because it could be used back in some future.

I hope it will help you to find your way :-)
If you have some ideas for other annotations, do not hesitate to post suggestions!
Thanks!

[The-Lum]

Hi @arnaudroques, and all.

Thanks for the annotations, that is a good beginning.
But how to search/detect all the dead code and adding automatically or not this annotation.
Do you know some tools or GitHub action for that?

Regards,
Th.

[The-Lum]

Hi @arnaudroques, and all.

In order to propose a PR;
If I change the error message No @startuml/@enduml found by No valid @start/@end found, please check the version

• Do you agree?

Regards,
Th.

[arnaudroques]

In order to propose a PR; If I change the error message No @startuml/@enduml found by No valid @start/@end found, please check the version

* Do you agree?

Yes, sure, you can go ahead.
Thanks for the idea!