Skip to content

Very very big documenting

Latest
Compare
Choose a tag to compare
@Nakama3942 Nakama3942 released this 31 Aug 10:38
· 4 commits to main since this release

Everything in the world is documented...

Documenting:

  • Fully documented in every detail all functionality of the library down to the smallest details!
  • Many examples have been written that describe the entire functionality of the library in detail.
  • Rewritten README.md: added many important details like Licenses, Library building, etc.
  • Added explanatory gifs to README.md.
  • Rewrote CHANGELOG.md: removed a lot of unnecessary text that only gets in the way.
  • Created a site with documentation and added a link to the repository.

Enhancements:

  • The file structure of the project was redistributed:
    • Header files are located in the include subdirectory;
    • Implementation files are located in the src subdirectory;
    • Test files are located in the test subdirectory;
    • Image files are located in the img subdirectory;
    • Example files are located in the example subdirectory;
    • Documentation files are located in the docs subdirectory;
    • Build files are located in the build subdirectory;
  • The files of implementations are distributed again, each according to its own category;
  • Optimized searcherOccurrencesOfSubstring() method;
  • A new cloneData() method was implemented (more precisely, the old cloneData() was renamed to cloneNewData() and a new cloneData() with a different implementation was added);
  • A convenient library assembly system was created for Windows and Linux platforms (makefile and test.sh);
  • Now all the functionality is compiled under any types (due to which the compilation time and weight of the library increased).