From 67ac001b417e0a5497f02e59cd33a2248964eac5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Christian=20Gl=C3=B6ckner?= <cgloeckner@freenet.de>
Date: Mon, 25 Jan 2016 16:26:49 +0100
Subject: Added docs for enginefactory

---
 drumgizmo/enginefactory.h | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/drumgizmo/enginefactory.h b/drumgizmo/enginefactory.h
index 02a84ae..d7e63ee 100644
--- a/drumgizmo/enginefactory.h
+++ b/drumgizmo/enginefactory.h
@@ -65,23 +65,39 @@
 #include "output/jackaudio.h"
 #endif
 
+//! Factory for various input- and output engines
 class EngineFactory
 {
 public:
+	//! Initialized lists of available engines (depending on enabled settings)
 	EngineFactory();
 
+	//! Query list of available input engines' names
+	//! \return const reference to the list
 	const std::list<std::string>& getInputEngines() const;
+	
+	//! Query list of available output engines' names
+	//! \return const reference to the list
 	const std::list<std::string>& getOutputEngines() const;
 
+	//! Create input engine by name
+	//! \param name Name of the input engine that should be initialized
+	//! \return unique_ptr to input engine or nullptr if engine is not supported
 	std::unique_ptr<AudioInputEngine> createInput(const std::string& name);
+	
+	//! Create input engine by name
+	//! \param name Name of the output engine that should be initialized
+	//! \return unique_ptr to input engine or nullptr if engine is not supported
 	std::unique_ptr<AudioOutputEngine> createOutput(const std::string& name);
 
 protected:
 	std::list<std::string> input, output; // available engines
 
 #ifdef USE_JACK
+	// Client that is used by all jack-related engines
 	std::unique_ptr<JackClient> jack;
 
+	// Utility to initialize jack (once)
 	void prepareJack();
 #endif
 
-- 
cgit v1.2.3