Documentation for jar_file

Author: Matthias Güdemann

jbmc/src/java_bytecode/jar_file.cpp

@@ -77,12 +77,20 @@ optionalt<std::string> jar_filet::get_entry(const std::string &name)
   }
 }
 
+/// Wrapper for `std::isspace` from `cctype`
+/// \param ch: the character to check
+/// \return true if the parameter is considered to be a space in the current
+///   locale, else false
 static bool is_space(const char ch)
 {
   return std::isspace(ch) != 0;
 }
 
 /// Remove leading and trailing whitespace characters from string
+/// \param begin: iterator to start search in string
+/// \param end: iterator to end search in string
+/// \return string truncated from begin to end and all whitespace removed at the
+///   begin and end
 static std::string trim(
   const std::string::const_iterator begin,
   const std::string::const_iterator end)

jbmc/src/java_bytecode/jar_file.h

@@ -18,7 +18,8 @@ Author: Diffblue Ltd
 
 #include "mz_zip_archive.h"
 
-/// Class representing a .jar archive
+/// Class representing a .jar archive uses miniz to decompress and index
+/// archive.
 class jar_filet final
 {
 public:
@@ -44,7 +45,8 @@ class jar_filet final
   /// \param filename Name of the file in the archive
   optionalt<std::string> get_entry(const std::string &filename);
 
-  /// Get contents of the Manifest file in the jar archive
+  /// Get contents of the Manifest file in the jar archive as a key-value map
+  /// (both as strings)
   std::unordered_map<std::string, std::string> get_manifest();
 
   /// Get list of filenames in the archive