Bug 462087

Summary: What API documentation?
Product: [Applications] partitionmanager Reporter: Ross Boylan <Ross.Boylan>
Component: generalAssignee: Andrius Štikonas <andrius>
Status: REPORTED ---    
Severity: normal    
Priority: NOR    
Version First Reported In: Git   
Target Milestone: ---   
Platform: Other   
OS: All   
Latest Commit: Version Fixed/Implemented In:
Sentry Crash Report:

Description Ross Boylan 2022-11-21 07:50:06 UTC 
SUMMARY
***
https://invent.kde.org/system/kpmcore/-/blob/master/README.md says, under the "Using KPMCore" section

> Most of the usage information on KPMcore is included in the API documentation

Where is that API documentation?

***


EXPECTED RESULT

I expected that the reference would include a link to a place I could view that documentation online.

Absent a link, I figured I could find such documentation with a web search; I've searched, but haven't turned up anything.

Absent any of that, I thought there might be instructions for how to build such documentation from the source code.  I haven't found that either.

I expected that "API Documentation" referred to something other than reading the header files.

ADDITIONAL INFORMATION

I'm not too familiar with building KDE software or its documentation system; perhaps at least my last place fallback (build it myself) is something that would be apparent if I were.  I did spend a little time looking for such information and didn't find it.
Comment 1 Andrius Štikonas 2022-11-21 09:26:31 UTC 
Hmm, I think it used to be on https://api.kde.org/kpmcore/ but indeed it seems to be missing now.

You can still read doxygen comments that are inline in the source code until above link comes back. (Even then  documentation really needs more work, it's not completely standalone)