From 985be86da093d1c50bd940e11f1909ca12ec7f78 Mon Sep 17 00:00:00 2001 From: malte_langkabel Date: Mon, 18 Apr 2016 11:50:44 +0200 Subject: [PATCH] ui: tutorial update * mentioned local symbols in tutorial * mentioned home button in tutorial --- .../projects/tutorial/src/code_tutorial_3.h | 1 + .../projects/tutorial/src/my_first_step.h | 8 ++-- .../data/projects/tutorial/src/my_next_step.h | 39 +++++++++++++++++++ .../projects/tutorial/src/search_tutorial_4.h | 5 ++- .../projects/tutorial/src/search_tutorial_5.h | 2 +- 5 files changed, 49 insertions(+), 6 deletions(-) create mode 100644 bin/app/data/projects/tutorial/src/my_next_step.h diff --git a/bin/app/data/projects/tutorial/src/code_tutorial_3.h b/bin/app/data/projects/tutorial/src/code_tutorial_3.h index bbc955cc..2fb982de 100644 --- a/bin/app/data/projects/tutorial/src/code_tutorial_3.h +++ b/bin/app/data/projects/tutorial/src/code_tutorial_3.h @@ -55,6 +55,7 @@ void function_with_snippets() the_central_hub(); + unrelated_but_very_important(); }; diff --git a/bin/app/data/projects/tutorial/src/my_first_step.h b/bin/app/data/projects/tutorial/src/my_first_step.h index a392f7f0..d125ff95 100644 --- a/bin/app/data/projects/tutorial/src/my_first_step.h +++ b/bin/app/data/projects/tutorial/src/my_first_step.h @@ -2,7 +2,7 @@ #define MY_FIRST_STEP_H -#include "the_central_hub.h" +#include "my_next_step.h" //------------------------------------------------------------------------------ // @@ -19,14 +19,14 @@ // did, Coati allows you to jump through the code base on your own. // // I THINK I GOT IT! -// Now that you understand Coati's central concept you are ready to jump -// further by activating "the_central_hub()" of this tutorial. +// Now that you understand Coati's central concept you are ready to activate +// the "my_next_step()" symbol below. // //------------------------------------------------------------------------------ void my_first_step() { - the_central_hub(); + my_next_step(2); } diff --git a/bin/app/data/projects/tutorial/src/my_next_step.h b/bin/app/data/projects/tutorial/src/my_next_step.h new file mode 100644 index 00000000..edfd1eaf --- /dev/null +++ b/bin/app/data/projects/tutorial/src/my_next_step.h @@ -0,0 +1,39 @@ +#ifndef MY_NEXT_STEP_H +#define MY_NEXT_STEP_H + + +#include "the_central_hub.h" + +//------------------------------------------------------------------------------ +// +// ANYTING ELSE I SHOULD KNOW? +// I'm glad that you asked. Take a look at the code below. You will notice two +// different highlights when hovering different symbols in that snippet. One +// is used for symbols that may be used everywhere throughout your code base +// while the other one is used to quickly highlight references to local +// symbols (like "foo" and "bar"). +// +// MORE ON LOCAL SYMBOLS +// These local symbols aren't covered by this tutorial. So don't you dare +// clicking them! Just kidding. Even though this tutorial doesn't make +// extensive use of local symbols these highlights prove really useful when +// inspecting a real code project. +// +// THAT'S ALL FOR NOW +// Your preliminary training is complete. You may proceed to +// "the_central_hub()" of this tutorial. +// +//------------------------------------------------------------------------------ + +int my_next_step(int foo) +{ + the_central_hub(); + + int bar = 2 * foo; + + return bar; +} + + +#endif // MY_NEXT_STEP_H + diff --git a/bin/app/data/projects/tutorial/src/search_tutorial_4.h b/bin/app/data/projects/tutorial/src/search_tutorial_4.h index 4dca2877..77021804 100644 --- a/bin/app/data/projects/tutorial/src/search_tutorial_4.h +++ b/bin/app/data/projects/tutorial/src/search_tutorial_4.h @@ -20,7 +20,10 @@ // of your code. The second button toggels the auto-refresh option. When // enabled Coati refreshes your project every time it's window gets focused. // -// 7 - WHAT'S NEXT? +// 7 - HOME +// This last button takes you back to the initial overview screen. +// +// 8 - WHAT'S NEXT? // Instead of the class activate the struct with the same name as before. // //------------------------------------------------------------------------------ diff --git a/bin/app/data/projects/tutorial/src/search_tutorial_5.h b/bin/app/data/projects/tutorial/src/search_tutorial_5.h index 7d3fa985..33345a22 100644 --- a/bin/app/data/projects/tutorial/src/search_tutorial_5.h +++ b/bin/app/data/projects/tutorial/src/search_tutorial_5.h @@ -6,7 +6,7 @@ //------------------------------------------------------------------------------ // -// 8 - CONGRATULATONS +// 9 - CONGRATULATONS // You have completed the challenge of search. // Oh, I almost forgot: You can only find nodes such as symbols via the search // bar. It doesn't allow you to find edges like calls or inheritance. At least