From 1b6e83ce9b56b773165387ac5f306e6807dc2900 Mon Sep 17 00:00:00 2001
From: vkalev <geireann.lindfield@gmail.com>
Date: Thu, 2 Dec 2021 15:25:14 -0500
Subject: Added header comment to CollectionLinearView

---
 .../views/collections/collectionLinear/CollectionLinearView.tsx   | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'src/client/views/collections/collectionLinear/CollectionLinearView.tsx')

diff --git a/src/client/views/collections/collectionLinear/CollectionLinearView.tsx b/src/client/views/collections/collectionLinear/CollectionLinearView.tsx
index 18a715edf..d67122eff 100644
--- a/src/client/views/collections/collectionLinear/CollectionLinearView.tsx
+++ b/src/client/views/collections/collectionLinear/CollectionLinearView.tsx
@@ -24,6 +24,14 @@ import "./CollectionLinearView.scss";
 type LinearDocument = makeInterface<[typeof documentSchema,]>;
 const LinearDocument = makeInterface(documentSchema);
 
+/**
+ * CollectionLinearView is the class for rendering the horizontal collection 
+ * of documents, it useful for horizontal menus. It can either be expandable
+ * or not using the linearViewExpandable field. 
+ * It is used in the following locations:
+ * - It is used in the popup menu on the bottom left (see docButtons() in MainView.tsx)
+ * - It is used for the context sensitive toolbar at the top (see contMenuButtons() in CollectionMenu.tsx)
+ */
 @observer
 export class CollectionLinearView extends CollectionSubView(LinearDocument) {
     @observable public addMenuToggle = React.createRef<HTMLInputElement>();
-- 
cgit v1.2.3-70-g09d2

