D17801: Update Okular developer documentation

[Yuri Chornoivan]

This revision was automatically updated to reflect the committed changes.
Closed by commit R223:3832a6522f3b: Update Okular developer documentation 
(authored by yurchor).

CHANGED PRIOR TO COMMIT
  https://phabricator.kde.org/D17801?vs=50309&id=51073#toc

REPOSITORY
  R223 Okular

CHANGES SINCE LAST UPDATE
  https://phabricator.kde.org/D17801?vs=50309&id=51073

REVISION DETAIL
  https://phabricator.kde.org/D17801

AFFECTED FILES
  Mainpage.dox
  core/generator.h
  core/global.h

To: yurchor, #okular, aacid
Cc: aacid, ngraham, okular-devel, tfella, darcyshen

D17801: Update Okular developer documentation

[Albert Astals Cid]

aacid accepted this revision.
aacid added a comment.
This revision is now accepted and ready to land.


  I have not carefully reviewed it, but it seems to be clearly better than what 
we have, so i'd say go ahead and commit it (without the setPlaceHolder changes 
that don't belong here i guess)

REPOSITORY
  R223 Okular

BRANCH
  dev_docs (branched from master)

REVISION DETAIL
  https://phabricator.kde.org/D17801

To: yurchor, #okular, aacid
Cc: aacid, ngraham, okular-devel, tfella, darcyshen

D17801: Update Okular developer documentation

[Yuri Chornoivan]

yurchor marked 3 inline comments as done.

REPOSITORY
  R223 Okular

REVISION DETAIL
  https://phabricator.kde.org/D17801

To: yurchor, #okular
Cc: aacid, ngraham, okular-devel, tfella, darcyshen

D17801: Update Okular developer documentation

[Yuri Chornoivan]

yurchor updated this revision to Diff 50309.
yurchor added a comment.


  Restore the original formats order, restore CMakeLists.txt, remove KAboutData 
include

REPOSITORY
  R223 Okular

CHANGES SINCE LAST UPDATE
  https://phabricator.kde.org/D17801?vs=48362&id=50309

BRANCH
  dev_docs (branched from master)

REVISION DETAIL
  https://phabricator.kde.org/D17801

AFFECTED FILES
  Mainpage.dox
  core/generator.h
  core/global.h
  ui/bookmarklist.cpp
  ui/searchwidget.cpp
  ui/side_reviews.cpp
  ui/toc.cpp

To: yurchor, #okular
Cc: aacid, ngraham, okular-devel, tfella, darcyshen

D17801: Update Okular developer documentation

[Albert Astals Cid]

aacid added inline comments.

INLINE COMMENTS

> Mainpage.dox:45
>  
> -  \li Portable Document Format (PDF)
> -  \li PostScript

I'd use the original sorting here, "noone" about xps but everyone cares about 
PDF, so it being on top makes sense

> Mainpage.dox:414
>  \verbatim
> -macro_optional_find_package(Okular)
> +remove_definitions(-DTRANSLATION_DOMAIN="okular")
> +add_definitions(-DTRANSLATION_DOMAIN="okular_markdown")

This changeset is wrong (or at least changes the original intent of the 
document), your changes are for building in source, while the manual is for 
people that build out of okular's source

> Mainpage.dox:754
>  
> -static KAboutData createAboutData()
> -{
> -KAboutData aboutData(...);
> -// fill the about data
> -return aboutData;
> -}
> +#include 
> +#include 

i guess we don't really need this

REPOSITORY
  R223 Okular

REVISION DETAIL
  https://phabricator.kde.org/D17801

To: yurchor, #okular
Cc: aacid, ngraham, okular-devel, tfella, darcyshen

D17801: Update Okular developer documentation

[Yuri Chornoivan]

yurchor added a comment.


  Ping?

REPOSITORY
  R223 Okular

REVISION DETAIL
  https://phabricator.kde.org/D17801

To: yurchor, #okular
Cc: ngraham, okular-devel, tfella, darcyshen, aacid

D17801: Update Okular developer documentation

[Yuri Chornoivan]

yurchor added a comment.


  **Off topic:** logo on the docs.kde.org is updated with the Breeze version. 
Should be visible next Thursday. If someone objects please let me know.

REPOSITORY
  R223 Okular

REVISION DETAIL
  https://phabricator.kde.org/D17801

To: yurchor, #okular
Cc: ngraham, okular-devel, darcyshen, aacid

D17801: Update Okular developer documentation

[Yuri Chornoivan]

yurchor added a comment.


  In D17801#384009 , @ngraham wrote:
  
  > While we're at it, maybe we could update the icon shown on the title page 
to display the current Breeze icon rather than the old KDE4-era Oxygen icon?
  
  
  That is a customized demo. It is not for delivering to someone. ;)
  
  If Okular developers will decide to share it somewhere we can use any icon 
you like.
  
  BTW, I can change the icon on the title page of the user documentation if you 
like the Breeze icon.
  
  https://docs.kde.org/trunk5/en/kdegraphics/okular/okular.pdf
  
  Personally, I think the new is not very self-evident and as good as the 
current Okular is.
  
  But that's the different story.

REPOSITORY
  R223 Okular

REVISION DETAIL
  https://phabricator.kde.org/D17801

To: yurchor, #okular
Cc: ngraham, okular-devel, darcyshen, aacid

D17801: Update Okular developer documentation

[Nathaniel Graham]

ngraham added a comment.


  While we're at it, maybe we could update the icon shown on the title page to 
display the current Breeze icon rather than the old KDE4-era Oxygen icon?

REPOSITORY
  R223 Okular

REVISION DETAIL
  https://phabricator.kde.org/D17801

To: yurchor, #okular
Cc: ngraham, okular-devel, darcyshen, aacid

D17801: Update Okular developer documentation

[Yuri Chornoivan]

yurchor added a comment.


  The current developer docs with the patch for easier inspection. Thanks in 
advance for your review.
  
  F6515969: refman.pdf 

REPOSITORY
  R223 Okular

REVISION DETAIL
  https://phabricator.kde.org/D17801

To: yurchor, #okular
Cc: okular-devel, ngraham, darcyshen, aacid

D17801: Update Okular developer documentation

[Yuri Chornoivan]

yurchor updated this revision to Diff 48362.
yurchor added a comment.


  Fix minor issues with the broken references.

REPOSITORY
  R223 Okular

CHANGES SINCE LAST UPDATE
  https://phabricator.kde.org/D17801?vs=48198&id=48362

BRANCH
  dev_docs (branched from master)

REVISION DETAIL
  https://phabricator.kde.org/D17801

AFFECTED FILES
  Mainpage.dox
  core/generator.h
  core/global.h

To: yurchor, #okular
Cc: okular-devel, ngraham, darcyshen, aacid

D17801: Update Okular developer documentation

[Yuri Chornoivan]

yurchor created this revision.
yurchor added a reviewer: Okular.
Herald added a project: Okular.
Herald added a subscriber: okular-devel.
yurchor requested review of this revision.

REVISION SUMMARY
  The current docs are for KDE 4 and slightly outdated. This patch tries to 
make them a bit up-to-date.

TEST PLAN
  Just a comparison with the current generators. No testing of code was 
conducted. Advices needed.

REPOSITORY
  R223 Okular

BRANCH
  dev_docs (branched from master)

REVISION DETAIL
  https://phabricator.kde.org/D17801

AFFECTED FILES
  Mainpage.dox

To: yurchor, #okular
Cc: okular-devel, ngraham, darcyshen, aacid