add docs

src/features/locators/reducers/createLocators.thunk.ts

@@ -13,6 +13,8 @@ interface Meta {
   library: ElementLibrary;
 }
 
+/* this thunk collects data from page, needed for locators business logic,
+finds child-parent connections and then saves locators to state */
 export const createLocators = createAsyncThunk("locators/createLocators", async (payload: Meta, thunkAPI) => {
   const { predictedElements, library } = payload;
   const state = thunkAPI.getState();

src/features/locators/reducers/identifyElements.thunk.ts

@@ -19,15 +19,20 @@ interface Meta {
 }
 
 export const identifyElements = createAsyncThunk("locators/identifyElements", async ({ pageObj }: Meta, thunkAPI) => {
+  /* set current page object and filter */
   thunkAPI.dispatch(setCurrentPageObj(pageObj));
+
+  /* set filter, if any exists in local storage */
   const state = thunkAPI.getState() as RootState;
   const library = selectPageObjById(state, pageObj)?.library || defaultLibrary;
   const savedFilters = getLocalStorage(LocalStorageKey.Filter);
-
   if (savedFilters && savedFilters[library]) {
     thunkAPI.dispatch(setFilter({ pageObjectId: pageObj, JDIclassFilter: savedFilters[library] }));
   }
 
+  /* Identify elements, needed for testing purposes. Depend on selected element library,
+  elements will be identified by predictElements() or findByRules().
+  Then adds needed locators to state and runs locator value generation. */
   try {
     const endpoint = predictEndpoints[library];
     const { data: res, pageData } =

src/features/locators/reducers/runLocatorsGeneration.thunk.ts

@@ -15,6 +15,10 @@ interface Meta {
   generateMissingLocator?: boolean;
 }
 
+/* Purpose of this thunk is to start locators generation.
+It's used for initial locators generation, or can be called on demand for particular locator type
+or with parameters.
+*/
 export const runLocatorsGeneration = createAsyncThunk(
   "locators/runLocatorsGeneration",
   async (meta: Meta, thunkAPI) => {

src/features/locators/utils/generationButton.ts

@@ -2,6 +2,7 @@ import { sendMessage } from "../../../pageServices/connector";
 import { getLibrarySelectors } from "../../../services/rules/createSelector";
 import { VueRules } from "../../../services/rules/Vue.rules";
 
+/* Runs elements identification based on algoritmic rules */
 export const findByRules = () => {
   const selectors = getLibrarySelectors(VueRules);
   return sendMessage

src/pageServices/pageDataHandlers.js

@@ -29,6 +29,9 @@ const sendToModel = async (payload, endpoint) => {
   return response;
 };
 
+/* First, plugin collects necessary data from the page.
+And then tha data is sent to endpoint, according to selected library.
+Function returns predicted elements. */
 export const predictElements = (endpoint) => {
   let pageData;
   return sendMessage