summaryrefslogtreecommitdiff
path: root/offapi
diff options
context:
space:
mode:
authorSamuel Mehrbrodt <Samuel.Mehrbrodt@cib.de>2017-11-02 15:57:42 +0100
committerSamuel Mehrbrodt <Samuel.Mehrbrodt@cib.de>2017-11-03 09:42:13 +0100
commit3135357a7441aa47141bab70447c0666ce24da42 (patch)
treea1ae90525e203eeb9baaf84db3f8dda6577fdfd1 /offapi
parent9a08e340ca7c5353b5347e5c5346c857d48011f4 (diff)
Fix comment markup
These do not appear on api.libreoffice.org if they arent marked up correctly Change-Id: I38873e1d763d97ff11e28b9ce5efe1cc68b12bf7 Reviewed-on: https://gerrit.libreoffice.org/44221 Reviewed-by: Samuel Mehrbrodt <Samuel.Mehrbrodt@cib.de> Tested-by: Samuel Mehrbrodt <Samuel.Mehrbrodt@cib.de>
Diffstat (limited to 'offapi')
-rw-r--r--offapi/com/sun/star/security/DocumentSignatureInformation.idl43
1 files changed, 22 insertions, 21 deletions
diff --git a/offapi/com/sun/star/security/DocumentSignatureInformation.idl b/offapi/com/sun/star/security/DocumentSignatureInformation.idl
index 39012bcd0491..8c411a7b276f 100644
--- a/offapi/com/sun/star/security/DocumentSignatureInformation.idl
+++ b/offapi/com/sun/star/security/DocumentSignatureInformation.idl
@@ -41,29 +41,30 @@ struct DocumentSignatureInformation
long SignatureDate;
long SignatureTime;
boolean SignatureIsValid;
- /* reflects the validity of the certificate.
- Contains a value from the constants of
- com::sun::star::security::CertificateValidity.
+ /**
+ * Reflects the validity of the certificate.
+ * Contains a value from the constants of com::sun::star::security::CertificateValidity.
*/
long CertificateStatus;
- /* indicates what content of a document is signed.
- <p>
- This value can be ignored when this struct is returned as part of
- a macro signature validation.
- As of OpenOffice.org 3.2 and ODF 1.2 the document signature comprises
- all files except the signature file itself.
- Signatures in OOo 2.x were only
- applied to the files in the root of the document, except mimetype, the
- Pictures and ObjectReplacements/Objects folder. That is, macros
- were not part of the document signature.
- OOo 3.0 signed everything, except mimetype and the META-INF folder.
- <p>
- If PartialDocumentSignature is true, then the signature was created by OOo
- with a version less then 3.2. In this case, not all files are signed. The
- signature can still be regarded as valid, as long as SignatureIsValid is true
- and the certificate could be validated. However, users should be notified about
- the fact, that not everything in this document is signed.
- */
+ /**
+ * Indicates what content of a document is signed.
+ * <p>
+ * This value can be ignored when this struct is returned as part of
+ * a macro signature validation.
+ * As of OpenOffice.org 3.2 and ODF 1.2 the document signature comprises
+ * all files except the signature file itself.
+ * Signatures in OOo 2.x were only
+ * applied to the files in the root of the document, except mimetype, the
+ * Pictures and ObjectReplacements/Objects folder. That is, macros
+ * were not part of the document signature.
+ * OOo 3.0 signed everything, except mimetype and the META-INF folder.
+ * <p>
+ * If PartialDocumentSignature is true, then the signature was created by OOo
+ * with a version less then 3.2. In this case, not all files are signed. The
+ * signature can still be regarded as valid, as long as SignatureIsValid is true
+ * and the certificate could be validated. However, users should be notified about
+ * the fact, that not everything in this document is signed.
+ */
boolean PartialDocumentSignature;
};