docs: Complete helper function documentation

[sysadminstory]

Complete documentation of the Helper functions

[dvikan]

i have mixed feelings. i dont like duplicate docs. id prefer the docs folder to at most contain a list of functions and a description

also some of these can be considered "internal" functions. the docs should be for public apis in my opinion.

[sysadminstory]

i have mixed feelings. i dont like duplicate docs. id prefer the docs folder to at most contain a list of functions and a description

What do you mean with "duplicate docs" ? Do you mean We should leave the technical details in the source itself, and a description in the docs folder ?

also some of these can be considered "internal" functions. the docs should be for public apis in my opinion.

I think those are "Helper functions" that were used in some bridge, so very dev creating a bridge should use them to not reinvent the wheel ?

Or did I misunderstood the scope of those functions ?

[dvikan]

the function signature is already present in the code. And usually there is comments above the function to explain purpose and formal parameters. I dont want to duplicate this information.

[sysadminstory]

Well, I see your point, but to be honest, if someone never mentioned in a pull request a function like Json::encode or Json::decode function, as a Bridge author, I wouldn't know those function would have existed.

I propose that the doc should list all helper functions, with a description, and a reference where it is defined.

Would this be something you could be ok with ?

[dvikan]

yes im okay with a simple list of all the functions

[sysadminstory]

Could the last commit correspond to the form of documentation expected ?

[dvikan]

sure