docs: dbus: add DBus API documentation #145
Conversation
…_str The use of platform_compat_str and platform_string was inconsistent, and not very critical, so I have chosen to use platform_string everywhere Signed-off-by: Artie Poole <stuart.poole@canonical.com>
artiepoole
added
documentation
necessary to pass inspection after updating clippy Signed-off-by: Artie Poole <stuart.poole@canonical.com>
artiepoole
force-pushed
the
artie/document_interfaces
branch
2 times, most recently
from
30b70d4 to
d89f332
Compare
daemon/src/comm/dbus/README.md
Outdated
There was a problem hiding this comment.
I think we could add all these documentation as rust docstring to the relevant places/functions etc. and then use rust docs to refer in readme which would have better interface and would be easier to maintain since the doc would reside with code
There was a problem hiding this comment.
That's actually a very good idea.
Can we host the docs here in the repo, and build them on merge or something (automation)?
There was a problem hiding this comment.
I think we can and actually if we publish this to cargo it will automatically have docs.rs page for us
There was a problem hiding this comment.
I think I registered the name for fpgad in cargo gonna add you as owner as well let me check
artiepoole
force-pushed
the
artie/document_interfaces
branch
from
d89f332 to
1654535
Compare
|
I have documented the code as suggested. I removed the original API readme. I also discovered an issue - we were writing out the requested data after writing it in fs_write_bytes - this is not good practice so I stopped this. I think we should also not do this in fs_write either. (it's great for debugging, sure, but "n_bytes" or just "succeeded" is better. As for the documentation - check out my branch and run |
documentation added for: - helper functions - StatusInterface - ControlInterface Documentation added at - top level - class level - function level Signed-off-by: Artie Poole <stuart.poole@canonical.com>
these are messy, and also could leak secure information Signed-off-by: Artie Poole <stuart.poole@canonical.com>
Signed-off-by: Artie Poole <stuart.poole@canonical.com>
Signed-off-by: Artie Poole <stuart.poole@canonical.com>
the hex value is returned as undecorated ascii (no 0x prefix) Signed-off-by: Artie Poole <stuart.poole@canonical.com>
Signed-off-by: Artie Poole <stuart.poole@canonical.com>
artiepoole
force-pushed
the
artie/document_interfaces
branch
from
1654535 to
d7a5734
Compare
The documentation is in:
daemon/src/comm/dbus/README.mdI also
platform_string, replacing usages ofplatform_compat_strcli/main.rs(clap'sargandcommand) to pass code formatting checks