Added header comment to CollectionLinearView

1 files changed, 8 insertions, 0 deletions

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>();