Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[authorization] Clarify pkgconfig requirements. Fixes JB#59315 #5

Merged
merged 1 commit into from Nov 14, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
25 changes: 23 additions & 2 deletions doc/index.qdoc
Expand Up @@ -95,8 +95,29 @@ CONFIG += link_pkgconfig
PKGCONFIG += amberwebauthorization
\endcode

It may then \c{#include <oauth1.h>}, \c{#include <oauth2.h>},
\c{#include <redirectlistener.h>} as required.
You'll also need to add the following to your RPM SPEC file.

\code
BuildRequires: pkgconfig(amberwebauthorization)
\endcode

If your project is using a YAML file to generate your SPEC file, don't edit
your SPEC file, but instead amend the YAML file to add \c{amberwebauthorization}
to the \c{PkgConfigBR} section, like this:

\code
PkgConfigBR:
- amberwebauthorization
\endcode

You can then use the headers in your code depending on the functionality you
need access to. Refer to the class documentation for which headers to include.

\code
#include <oauth1.h>
#include <oauth2.h>
llewelld marked this conversation as resolved.
Show resolved Hide resolved
#include <redirectlistener.h>
\endcode

\section2 QML API

Expand Down