Change annotations to match the standardese style

[iamveritas]

Change Description

Change annotations to be Standardese compatible.
Resolves #392

• Deployment Changes

• API Changes

• Documentation Additions

Notes

• the most important change I think is this one, please take a look and comment: https://github.com/EOSIO/eosio.contracts/pull/426/files#r362316305

[iamveritas]

N.B. this type of change is a must, otherwise standardese chokes with a critical error and aborts its execution, that is, the [[eosio::action]] has to be on the same line with the function declaration.

[dskvr]

@larryk85 Does this cause issues? There is no way around this requirement when using Standardese. When the C++ style declarations are multi-line Standardese does not find the entity.

It could be possible to fix this, but not sure if we have the resources. Are multi-line declaration/entity signatures a compiler requirement?

[larryk85]

They are not a compiler requirement, the attributes are only lexically linked to the first binding token. So you can place them on the same line or 100 lines between them, the compiler doesn't care. That is odd that standardese would fail on that, it should be using Clang to parse the code and working off of the AST that it generates. I would've expected it to fail in both cases then.

[iamveritas]

@larryk85 @dskvr
status: if we want standardese annotations we have to either live with this constraint mentioned above (eosio action attribute has to be on the same line with the function declaration) or we should find a way in our clang patch to address this matter.
which one should we go with?