From 503d6b7f075f1e9685de84749c737c1a3fe81a56 Mon Sep 17 00:00:00 2001
From: Daniel Krebs <github@daniel-krebs.net>
Date: Tue, 13 Feb 2018 16:38:51 +0100
Subject: [PATCH] lib/ip: cleanup formatting and comments of IpCore's member
 variables

---
 fpga/include/villas/fpga/ip.hpp | 20 +++++++++++++-------
 1 file changed, 13 insertions(+), 7 deletions(-)

diff --git a/fpga/include/villas/fpga/ip.hpp b/fpga/include/villas/fpga/ip.hpp
index fc3a777e0..aff0ed891 100644
--- a/fpga/include/villas/fpga/ip.hpp
+++ b/fpga/include/villas/fpga/ip.hpp
@@ -150,14 +150,20 @@ protected:
 	InterruptController*
 	getInterruptController(const std::string& interruptName);
 
-protected:
-	virtual std::list<std::string> getMemoryBlocks() const { return {}; }
+	/// Each IP can declare via this function which memory blocks it requires
+	virtual std::list<std::string>
+	getMemoryBlocks() const
+	{ return {}; }
 
-	// populated by FpgaIpFactory
-	PCIeCard* card;					///< FPGA card this IP is instantiated on
-	IpIdentifier id;				///< VLNV and name defined in JSON config
-	std::map<std::string, IrqPort> irqs;	///< Interrupts of this IP component
-	std::map<std::string, IpCore*> dependencies; ///< dependencies on other IPs
+protected:
+	/// FPGA card this IP is instantiated on (populated by FpgaIpFactory)
+	PCIeCard* card;
+
+	/// Identifier of this IP with its instance name and VLNV
+	IpIdentifier id;
+
+	/// All interrupts of this IP with their associated interrupt controller
+	std::map<std::string, IrqPort> irqs;
 
 	/// Cached translations from the process address space to each memory block
 	std::map<std::string, MemoryTranslation> addressTranslations;