From 2946c2c2dce5be32b765d492da0bd5872a96d021 Mon Sep 17 00:00:00 2001 From: kellijohnson-NOAA Date: Thu, 19 Sep 2024 14:02:10 -0700 Subject: [PATCH] doc(C++): Put list of educational links rather than using the glossary Closes #144 --- 02-FIMS-Project-Overview.Rmd | 8 ++++++ 11-glossary.Rmd | 56 ------------------------------------ 2 files changed, 8 insertions(+), 56 deletions(-) delete mode 100644 11-glossary.Rmd diff --git a/02-FIMS-Project-Overview.Rmd b/02-FIMS-Project-Overview.Rmd index 29ad2b2..bbc3497 100644 --- a/02-FIMS-Project-Overview.Rmd +++ b/02-FIMS-Project-Overview.Rmd @@ -28,6 +28,14 @@ Run [`cmake --build build` and `ctest --test-dir build` locally](https://noaa-fi and make sure the C++ tests pass before pushing tests to remote feature branch. If there are failing tests, run `ctest --test-dir --rerun-failed --output-on-failure` to re-run the failed tests verbosely. * Ensuring the run-clang-tidy and run-googletest [Github Actions workflows](#github-actions) pass on the remote feature branch +Below is a list of online resources for learning C++: +* [cplusplus.com](https://cplusplus.com/doc/) +* [docs.microsoft.com](https://docs.microsoft.com/en-us/cpp/standard-library) +* [geeksforgeeks.org](https://www.geeksforgeeks.org/c-plus-plus/?ref=outind) +* [learncpp.com](https://www.learncpp.com/cpp-tutorial) +* [positioniseverything.net](https://www.positioniseverything.net/category/coding/c/) +* [w3schools.com/cpp](https://www.w3schools.com/cpp) + ### R developers The R developers responsibilities include: diff --git a/11-glossary.Rmd b/11-glossary.Rmd deleted file mode 100644 index 923ceda..0000000 --- a/11-glossary.Rmd +++ /dev/null @@ -1,56 +0,0 @@ -# Glossary {-} - -## C++ Glossary - -Some C++ vocabulary that is used within FIMS that will be helpful for novice C++ programmers -to understand. - -### singleton - -Defines a class that is only used to create an object one time. This is a design pattern. - -See more [information](https://www.positioniseverything.net/cpp-singleton) - -### class - -Provides the "recipe" for the structure of an object, including the data members and functions. -Like data structures (structs), but also includes functions. - -See more [information](https://cplusplus.com/doc/tutorial/classes/). - -### functor - -A functor is a class that acts like a function. - -See more [details about functors](https://docs.microsoft.com/en-us/cpp/standard-library/function-objects-in-the-stl?view=msvc-170). -### constructor - -A special method that is called when a new object is created and -usually initializes data members of the object. - -See the [definition of constructor](https://www.geeksforgeeks.org/constructors-c/). - -### destructor - -The last method of an object called automatically before an object is destroyed. - -See the [definition of destructor](https://www.geeksforgeeks.org/destructors-c/). - -### header guards - -Makes sure that there are not multiple copies of a header in a file. - -Details are [available](https://www.learncpp.com/cpp-tutorial/header-guards/). - -### preprocessing macro/derectives - -Begin with a `#` in the code, these tell the preproccessor (not the compiler) what to do. -These directives are complete before compiling. - -See more info on [preprocessing](https://cplusplus.com/doc/tutorial/preprocessor/) - -### struct - -Similar to a class, but only contains data members and not functions. All members are public. Comes from C. - -See [details on struct](https://www.w3schools.com/cpp/cpp_structs.asp.)