Add and improve user scripting api docs from 2.9
ClosedPublic

Authored by piggz on May 16 2017, 9:48 PM.

Details

Summary

Add docs from 2.9 and improve

Test Plan

Const and comment changes only

Diff Detail

Repository
R14 KReport
Branch
script_docs
Lint
No Linters Available
Unit
No Unit Test Coverage
piggz created this revision.May 16 2017, 9:48 PM
Restricted Application added a project: KReport. · View Herald TranscriptMay 16 2017, 9:48 PM
staniek edited edge metadata.May 16 2017, 10:16 PM

Good!
Minor: How about removing the use of @ author? It breaks the docs a bit. Instead let's have AUTHORS file as in kexi.git. There's also Mainpage.dox.

staniek requested changes to this revision.May 16 2017, 10:17 PM
This revision now requires changes to proceed.May 16 2017, 10:17 PM
piggz updated this revision to Diff 14641.May 17 2017, 4:55 PM
piggz edited edge metadata.
  • Fix typos and add Authors
  • Remove @authors lines
staniek requested changes to this revision.May 17 2017, 5:23 PM
staniek added inline comments.
AUTHORS
4

Good,
Based on git shortlog -ns also at least:
Friedrich W. H. Kossebau
Boudewijn Rempt
Radoslaw Wicik
Shreya Pandit

Doxyfile
47

If it's just for scripting how about renaming to Scripting.dox?

Later we would have doxygen sections: general API, elements API, scripting.

This revision now requires changes to proceed.May 17 2017, 5:23 PM
piggz updated this revision to Diff 14646.May 17 2017, 10:16 PM
piggz edited edge metadata.
  • Minor tweaks
staniek requested changes to this revision.May 17 2017, 11:46 PM
staniek added inline comments.
Doxyfile
47

Sorry, please ignore "If it's just for scripting how about renaming to Scripting.dox?"

I meant just this: this Doxyfile is just for scripting so how about renaming it to something else. Like "Doxyfile-scripting" or so. We're not using a doxyfile for entire KReport api docs, it's generated.

So

  • PROJECT_BRIEF = "The API guide for KReport" is not needed change -- this Doxyfile is just for scripting
  • OUTPUT_DIRECTORY = ./doxygen is not needed change -- this Doxyfile is just for scripting

I can change if I messed up the message :)

KReportScript.dox
6

This is OK change

This revision now requires changes to proceed.May 17 2017, 11:46 PM
piggz updated this revision to Diff 14676.May 18 2017, 6:30 PM
piggz edited edge metadata.
  • Fixups
staniek accepted this revision.May 18 2017, 6:34 PM

Perfect

This revision is now accepted and ready to land.May 18 2017, 6:34 PM
This revision was automatically updated to reflect the committed changes.