From f43ddc74ade3a921ea7c3513aeb6306fc2af6982 Mon Sep 17 00:00:00 2001
From: lloyd <lloyd@randombit.net>
Date: Mon, 21 Jun 2010 14:20:45 +0000
Subject: Doxygen

---
 src/asn1/asn1_int.h | 25 ++++++++++++++++++++-----
 src/asn1/asn1_obj.h |  4 ++--
 2 files changed, 22 insertions(+), 7 deletions(-)

(limited to 'src')

diff --git a/src/asn1/asn1_int.h b/src/asn1/asn1_int.h
index 3562f692b..cac46190f 100644
--- a/src/asn1/asn1_int.h
+++ b/src/asn1/asn1_int.h
@@ -56,8 +56,18 @@ enum ASN1_Tag {
 class BOTAN_DLL ASN1_Object
    {
    public:
-      virtual void encode_into(class DER_Encoder&) const = 0;
-      virtual void decode_from(class BER_Decoder&) = 0;
+      /**
+      * Encode whatever this object is into to
+      * @param to the DER_Encoder that will be written to
+      */
+      virtual void encode_into(class DER_Encoder& to) const = 0;
+
+      /**
+      * Decode whatever this object is from from
+      * @param from the BER_Decoder that will be read from
+      */
+      virtual void decode_from(class BER_Decoder& from) = 0;
+
       virtual ~ASN1_Object() {}
    };
 
@@ -80,9 +90,14 @@ class DataSource;
 
 namespace ASN1 {
 
-SecureVector<byte> put_in_sequence(const MemoryRegion<byte>&);
-std::string to_string(const BER_Object&);
-bool maybe_BER(DataSource&);
+SecureVector<byte> put_in_sequence(const MemoryRegion<byte>& val);
+std::string to_string(const BER_Object& obj);
+
+/**
+* Heuristics tests; is this object possibly BER?
+* @param src a data source that will be peeked at but not modified
+*/
+bool maybe_BER(DataSource& src);
 
 }
 
diff --git a/src/asn1/asn1_obj.h b/src/asn1/asn1_obj.h
index 6800166e6..0672e6a44 100644
--- a/src/asn1/asn1_obj.h
+++ b/src/asn1/asn1_obj.h
@@ -23,8 +23,8 @@ namespace Botan {
 class BOTAN_DLL Attribute : public ASN1_Object
    {
    public:
-      void encode_into(class DER_Encoder&) const;
-      void decode_from(class BER_Decoder&);
+      void encode_into(class DER_Encoder& to) const;
+      void decode_from(class BER_Decoder& from);
 
       OID oid;
       MemoryVector<byte> parameters;
-- 
cgit v1.2.3