diff options
| author | Patrick Griffis <pgriffis@igalia.com> | 2020-09-19 19:53:10 -0700 |
|---|---|---|
| committer | Patrick Griffis <pgriffis@igalia.com> | 2020-09-19 19:53:10 -0700 |
| commit | 0d8cb98597bcd14a10a14f9174ead5b07c1e2b97 (patch) | |
| tree | 9d9e777df5c35c8c83f5066ce7da38197bfd8bc1 | |
| parent | 5ebca446abd2be8f994c5812dad68b074ba03914 (diff) | |
| download | libsoup-0d8cb98597bcd14a10a14f9174ead5b07c1e2b97.tar.gz | |
docs: Fix minor docs issues for HSTSEnforcer
| -rw-r--r-- | libsoup/hsts/soup-hsts-enforcer.h | 4 | ||||
| -rw-r--r-- | libsoup/hsts/soup-hsts-policy.c | 15 |
2 files changed, 5 insertions, 14 deletions
diff --git a/libsoup/hsts/soup-hsts-enforcer.h b/libsoup/hsts/soup-hsts-enforcer.h index ba7d43f5..d0223188 100644 --- a/libsoup/hsts/soup-hsts-enforcer.h +++ b/libsoup/hsts/soup-hsts-enforcer.h @@ -24,7 +24,8 @@ G_DECLARE_DERIVABLE_TYPE (SoupHSTSEnforcer, soup_hsts_enforcer, SOUP, HSTS_ENFOR * change the scheme of the #SoupURI in the #SoupMessage to HTTPS. Implementations might want to * chain up to the @has_valid_policy in the parent class to check, for instance, for runtime * policies. - * @changed: the class closure for the #SoupHSTSEnforcer::changed signal. + * @changed: The class closure for the #SoupHSTSEnforcer::changed signal. + * @hsts_enforced: The class closure for the #SoupHSTSEnforcer::hsts-enforced signal. **/ struct _SoupHSTSEnforcerClass { GObjectClass parent_class; @@ -40,6 +41,7 @@ struct _SoupHSTSEnforcerClass { void (*hsts_enforced) (SoupHSTSEnforcer *enforcer, SoupMessage *message); + /* <private> */ gpointer padding[4]; }; diff --git a/libsoup/hsts/soup-hsts-policy.c b/libsoup/hsts/soup-hsts-policy.c index 39bce01d..2bae29ba 100644 --- a/libsoup/hsts/soup-hsts-policy.c +++ b/libsoup/hsts/soup-hsts-policy.c @@ -19,25 +19,14 @@ #include "soup.h" /** - * SECTION:soup-hsts-policy - * @short_description: HTTP Strict Transport Security policies - * @see_also: #SoupHSTSEnforcer - * - * #SoupHSTSPolicy implements HTTP policies, as described by <ulink - * url="http://tools.ietf.org/html/rfc6797">RFC 6797</ulink>. - * - * To have a #SoupSession handle HSTS policies for your appliction - * automatically, use a #SoupHSTSEnforcer. - **/ - -/** * SoupHSTSPolicy: * @domain: The domain or hostname that the policy applies to * @max_age: The maximum age, in seconds, that the policy is valid * @expires: the policy expiration time, or %NULL for a permanent session policy * @include_subdomains: %TRUE if the policy applies on subdomains * - * An HTTP Strict Transport Security policy. + * #SoupHSTSPolicy implements HTTP policies, as described by + * [RFC 6797](http://tools.ietf.org/html/rfc6797). * * @domain represents the host that this policy applies to. The domain * must be IDNA-canonicalized. soup_hsts_policy_new() and related methods |