docs(bindings/C): The documentation for OpenDAL C binding

[xyjixyjixyji]

This PR uses doxygen to generate documentations for C binding.

Developers could call make doc to generate documentations in ./docs/doxygen/html/index.html.

The documentations in the Rust code for C binding now uses the doxygen style.

[xyjixyjixyji]

Related #2321

This is relative a big PR but almost w/o funcationality changes.
Reviewers could ignore the additions under ./docs and try make doc locally instead if wanted.

[xyjixyjixyji]

It seems the CI is failing on the files generated by doxygen, is there any workaround?

[suyanhanx]

You may not commit them. We just need to generate those docs in the CI job and deploy them as a part of our site.
Please take our docs ci job config as an example. @Ji-Xinyou

FYI:

• https://github.com/apache/incubator-opendal/blob/main/.github/workflows/docs.yml

[xyjixyjixyji]

You may not commit them. We just need to generate those docs in the CI job and deploy them as a part of our site.

Sure

[xyjixyjixyji]

I have updated on the github action, I am not an expert on it so PTAL ❤️

[xyjixyjixyji]

Another problem is that the licence header CI requires C files to be started with

/**
 * sth
 */

However, that would make the header part of the documentation (in the first struct appears in the doc). Therefore I change it to

/*
 * sth
 */

But this cannot pass the licence header check.

[suyanhanx]

Another problem is that the licence header CI requires C files to be started with

/**
 * sth
 */

However, that would make the header part of the documentation (in the first struct appears in the doc). Therefore I change it to

/*
 * sth
 */

But this cannot pass the licence header check.

cc @tisonkun

[tisonkun]

However, that would make the header part of the documentation (in the first struct appears in the doc). Therefore I change it to

I know for this part. Perhaps I can change the default in the hawkeye core later. For now, you can add the following config to the licenserc.toml file to change it:

[mapping.SLASHSTAR_STYLE]
extensions = ["c", "h"]

For changes upstream, perhaps something like this one korandoru/hawkeye@33e482f

[jiaoew1991]

https://github.com/apache/incubator-opendal/blob/59af64663692ac5109e50f47de7c77a91a551c2a/bindings/c/src/lib.rs#L91-L96

I have a simple question, why does this place still support memory scheme? Other schemes should also have similar methods, which should be easy to add.

[xyjixyjixyji]

I have a simple question, why does this place still support memory scheme? Other schemes should also have similar methods, which should be easy to add.

Thanks for pointing it out! 👍 This is indeed a problem.

[Xuanwo]

I have a simple question, why does this place still support memory scheme? Other schemes should also have similar methods, which should be easy to add.

Yes, we can remove generate_operator.

[Xuanwo]

Thanks a lot!