google / cel-cpp

Fast, portable, non-Turing complete expression evaluation (C++)
https://cel.dev
Apache License 2.0
167 stars 48 forks source link

HTML docs for C++ implementation #107

Open hickford opened 3 years ago

hickford commented 3 years ago

Hi. I found the docs for the CEL spec at https://github.com/google/cel-spec/tree/master/doc . Is there any further documentation for this C++ implementation beyond the code comments in header files? And can I browse the API in doxygen-style reference documentation anywhere?

hickford commented 3 years ago

Ideally similar to how Protocol Buffers has generated HTML documentation for the C++ API https://developers.google.com/protocol-buffers/docs/reference/cpp

TristonianJones commented 3 years ago

A doxygen style reference, or a port of the CEL Go Codelab would be very useful for C++ but we don't yet have such references. I'll be sure to ping this bug when I do.

https://codelabs.developers.google.com/codelabs/cel-go

mx1up commented 4 months ago

codelab seems to be added by now https://github.com/google/cel-cpp/tree/master/codelab

vincasrazmabentley commented 2 months ago

Could a link to codelab documentation be added to readme? We had hard time finding it, in a bit unexpected place https://github.com/google/cel-cpp/blob/master/README.md