Frameworks/Epics/Apidox refresh: Difference between revisions

From KDE Community Wiki
(First version of apidox refresh page)
 
Line 32: Line 32:
* Update `Library_Documentation_Policy` to contain KF5 documentation.
* Update `Library_Documentation_Policy` to contain KF5 documentation.
| ??}}
| ??}}
{{FeatureTodo|Document framework.yaml and README.md files| ??}}
|}
|}



Revision as of 13:06, 23 January 2014

On framework themselves

Status Task Contact
TO DO Migrate Mainpage.dox to README.md (see also: Necessary files) ?? <{{{3}}}>
TO DO Standardize documentation dir ("dox" vs "docs", image dir) ?? <{{{3}}}>

On kapidox tools

Must Have

Status Task Contact
TO DO Deploy new scripts on api.kde.org ?? <{{{3}}}>
TO DO Decide where to host documentation policy.

There is currently http://techbase.kde.org/Policies/Library_Documentation_Policy for kdelibs4.

Proposal:

  • Copy `Library_Documentation_Policy` to `KDE4_Library_Documentation_Policy`.
  • Link to it from `Library_Documentation_Policy`.
  • Update `Library_Documentation_Policy` to contain KF5 documentation.
?? <{{{3}}}>
TO DO Document framework.yaml and README.md files ?? <{{{3}}}>

Nice to Have

Status Task Contact
TO DO Integrate generation of dependency diagrams in kgenframeworksapidox ?? <{{{3}}}>
TO DO Define a way to list undocumented elements ?? <{{{3}}}>
TO DO Look into the search system, evaluate a client-side only system. Rationale: more uniform, easier to test. ?? <{{{3}}}>