fix: path to solution; added references

[seehma]

Hi, here is the fix for your zkdoc problem. the source code to your plc project was moved -> zkdoc does that need to know too. i also added the references in order to be able to build the library eventually later with zkbuild, if you like. filepath in documentation.yml can be . only, it is only needed if no config.json is provided. Regards M.

[bengeisler]

That sounds logical! Thanks for fixing it 👍 However, now the Action fails because of authentication:

My secrets are the same from the last successful run.

Thanks a lot for your time, by the way! You've invested quite a bit now in this project.

[seehma]

Hi, can you try to trigger the merged action manually. I think this happened because it was executed in "branch-scope". Regards M.

[bengeisler]

Now it fails for a different reason:

[seehma]

Hi, we had a problem regarding your folder structure, can you please try once more? (you dont have to change anything, just start the action once again) Thanks...

[bengeisler]

Thanks! It's working!

Regarding the question of excluding private and internal methods / types etc. from the documentation - is that something you'll be working on?

Or what's your strategy of documenting the public API of a library?

[seehma]

Hi, currently everything which is marked as INTERNAL (e.g. for DataTypes) or with attribute hide, is not shown in the documentation. In the case, if something is marked with the above keywords and you have a xref in your documentation on one of those DUTs for example, zkdoc will generate an error. Is that what you wanted? In our case (Zeugwerk Framework) all open, API-things are documented, and of course everything which describes the API. All internal things are marked with the mentioned keywords above and therefore not shown in our API-doc. Regards M.

[bengeisler]

Hi, yes, with the pragma {attribute 'hide'} everything seems to work except methods. I'd like to hide private helper methods within public function blocks. These still make it into the docs:

Also, I found that for interfaces and functions INTERNAL alone was not enough, I also had to use {attribute 'hide'}.

And last thing, for cherries on the cake, it would be nice to show the values of constants in the docs, maybe in an additional column.

[seehma]

Hi, thanks for your reply. We are working on those things and made some Issues -> i will inform you if there are any changes on this. This could take some time, so i hope thats ok for you. Regards M.