[tepl] docs: recommendation for TeplAbstractFactory subclass name



commit 9bf162a282598f8c12b4bb81e1186eb4895a5951
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Fri Nov 3 12:30:43 2017 +0100

    docs: recommendation for TeplAbstractFactory subclass name

 tepl/tepl-abstract-factory.c |    6 ++++++
 1 files changed, 6 insertions(+), 0 deletions(-)
---
diff --git a/tepl/tepl-abstract-factory.c b/tepl/tepl-abstract-factory.c
index e789510..9c2ac5e 100644
--- a/tepl/tepl-abstract-factory.c
+++ b/tepl/tepl-abstract-factory.c
@@ -37,6 +37,12 @@
  * #TeplView overrides to create a #TeplBuffer. How the #TeplView and
  * #TeplBuffer are created can be customized with the ::create_tab vfunc of
  * #TeplAbstractFactory.
+ *
+ * Recommendation for the subclass name: in Tepl, #TeplAbstractFactory is an
+ * abstract class, but in an application it is a concrete class. So
+ * “MyappAbstractFactory” is not a good name for a #TeplAbstractFactory
+ * subclass. “MyappFactory” is a better name (of course change “Myapp” with the
+ * application namespace).
  */
 
 /* API design:


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]