Browse Source

Fixed all error messages in Doxygen log

master
Christopher 8 years ago
parent
commit
dcd6c599c0
  1. 4
      Assets/Fungus/Scripts/Interfaces/IWriter.cs
  2. 5
      Assets/Fungus/Scripts/Utils/ConversationManager.cs
  3. 4
      Docs/fungus_docs/about_fungus.md
  4. 2
      Docs/fungus_docs/community_tutorials.md
  5. 38
      Docs/fungus_docs/faq.md
  6. 2
      Docs/fungus_docs/flowcharts.md
  7. 2
      Docs/fungus_docs/getting_started.md
  8. 5
      Docs/fungus_docs/glossary.md
  9. 2
      Docs/fungus_lua/lua_controlling_fungus.md
  10. 2
      Docs/fungus_lua/lua_environment.md
  11. 4
      Docs/fungus_lua/lua_utils.md

4
Assets/Fungus/Scripts/Interfaces/IWriter.cs

@ -58,7 +58,9 @@ namespace Fungus
/// ///
void OnInput(); void OnInput();
/// Called when the Writer starts writing new text /// <summary>
/// Called when the Writer starts writing new text.
/// </summary>
/// <param name="audioClip">An optional audioClip sound effect can be supplied (e.g. for voiceover)</param> /// <param name="audioClip">An optional audioClip sound effect can be supplied (e.g. for voiceover)</param>
void OnStart(AudioClip audioClip); void OnStart(AudioClip audioClip);

5
Assets/Fungus/Scripts/Utils/ConversationManager.cs

@ -137,7 +137,10 @@ namespace Fungus.Utils
/// Using the string of say parameters before the ':', /// Using the string of say parameters before the ':',
/// set the current character, position and portrait if provided. /// set the current character, position and portrait if provided.
/// </summary> /// </summary>
/// <param name="sayParams">The list of say parameters</param> /// <returns>The conversation item.</returns>
/// <param name="sayParams">The list of say parameters.</param>
/// <param name="text">The text for the character to say.</param>
/// <param name="currentCharacter">The currently speaking character.</param>
protected virtual ConversationItem CreateConversationItem(string[] sayParams, string text, Character currentCharacter) protected virtual ConversationItem CreateConversationItem(string[] sayParams, string text, Character currentCharacter)
{ {
var item = new ConversationItem(); var item = new ConversationItem();

4
Docs/fungus_docs/about_fungus.md

@ -54,7 +54,7 @@ We welcome all sorts of contributions to %Fungus. You can report bugs, suggest n
![img cookbook] ![img cookbook]
[Paul Mc Grath] is Animator / Designer / Film-maker at Whackala. He contributed the [tutorial videos] for this site as well as creating the [%Fungus Training Course]. Special thanks also to [Vicky Lee] and [Coding Grace] who have helped us to organise loads of %Fungus workshops, [Paul Mc Grath] is Animator / Designer / Film-maker at Whackala. He contributed the @ref tutorial_videos for this site as well as creating the @ref training_course. Special thanks also to [Vicky Lee] and [Coding Grace] who have helped us to organise loads of %Fungus workshops,
%Fungus wouldn't be possible without all the awesome people in our community who have contributed to the project and supported us in myriad ways. Thank you all! %Fungus wouldn't be possible without all the awesome people in our community who have contributed to the project and supported us in myriad ways. Thank you all!
@ -71,8 +71,6 @@ The %Fungus documentation is licensed under the [Creative Commons Attribution-No
[Vicky Lee]: https://twitter.com/whykay [Vicky Lee]: https://twitter.com/whykay
[Paul Mc Grath]: http://whackala.com [Paul Mc Grath]: http://whackala.com
[Coding Grace]: https://www.codinggrace.com [Coding Grace]: https://www.codinggrace.com
[tutorial videos]: tutorial_videos/index.md
[%Fungus Training Course]: training_course/index.md
[FungusGames.com]: http://www.fungusgames.com [FungusGames.com]: http://www.fungusgames.com
[community forum]: http://fungusgames.com/forum [community forum]: http://fungusgames.com/forum
[Twine]: http://twinery.org [Twine]: http://twinery.org

2
Docs/fungus_docs/community_tutorials.md

@ -23,7 +23,7 @@ If you've created an article or video about %Fungus let us know on the forum and
- [Creating Revision Apps as Text Adventures](http://davidsherlock.co.uk/creating-revision-apps-as-text-adventures/) - [Creating Revision Apps as Text Adventures](http://davidsherlock.co.uk/creating-revision-apps-as-text-adventures/)
- [More attempts to create revision apps using free resources](http://davidsherlock.co.uk/more-attempts-to-create-revision-apps-using-free-resources) - [More attempts to create revision apps using free resources](http://davidsherlock.co.uk/more-attempts-to-create-revision-apps-using-free-resources)
- [Creating your own hidden object game](http://davidsherlock.co.uk/starting-your-own-hidden-object-game) - [Creating your own hidden object game](http://davidsherlock.co.uk/starting-your-own-hidden-object-game)
- [Setting up Unity and %Fungus to make #appliedgames](https://youtu.be/t1zf4Qq_GS8) - [Setting up Unity and %Fungus to make appliedgames](https://youtu.be/t1zf4Qq_GS8)
# Leah Lee # {#leah_lee} # Leah Lee # {#leah_lee}

38
Docs/fungus_docs/faq.md

@ -1,64 +1,64 @@
# Frequently Asked Questions # {#faq} # Frequently Asked Questions # {#faq}
[TOC] [TOC]
# What is Fungus? # {#what_is_fungus} # What is Fungus? # {#faq_what_is_fungus}
%Fungus is a free open source tool for creating storytelling games, with a strong focus on accessibility for novice game developers. Users all over the world are now using it to create a wonderfully diverse range of storytelling games. %Fungus is a free open source tool for creating storytelling games, with a strong focus on accessibility for novice game developers. Users all over the world are now using it to create a wonderfully diverse range of storytelling games.
# Who makes Fungus? # {#who_makes} # Who makes Fungus? # {#faq_who_makes}
%Fungus is developed by [Snozbot], a small independent games company. Chris Gregan is the main developer of %Fungus. %Fungus is developed by [Snozbot], a small independent games company. Chris Gregan is the main developer of %Fungus.
# Where do I get Fungus? # {#where_get} # Where do I get Fungus? # {#faq_where_get}
%Fungus is available on the [Unity Asset Store] and in the download section of this website. %Fungus is available on the [Unity Asset Store] and in the download section of this website.
# Is Fungus really free to use? # {#really_free} # Is Fungus really free to use? # {#faq_really_free}
Yes. %Fungus has an Open Source M.I.T. license. You can use %Fungus with any version of the Unity game engine, including the freely available personal edition. Yes. %Fungus has an Open Source M.I.T. license. You can use %Fungus with any version of the Unity game engine, including the freely available personal edition.
# Can I sell the apps I make with Fungus? # {#can_sell} # Can I sell the apps I make with Fungus? # {#faq_can_sell}
Yes. We do not charge a license fee. Yes. We do not charge a license fee.
# What platforms does Fungus support? # {#platforms} # What platforms does Fungus support? # {#faq_platforms}
%Fungus runs on any platform supported by the Unity game engine. See here for a list of supported platforms. %Fungus runs on any platform supported by the Unity game engine. See here for a list of supported platforms.
# Do I need to be a programmer to use Fungus? # {#non_coders} # Do I need to be a programmer to use Fungus? # {#faq_non_coders}
No. %Fungus can be used to make a variety of story-driven games with no coding required. No. %Fungus can be used to make a variety of story-driven games with no coding required.
# Is Fungus useful for programmers? # {#coders} # Is Fungus useful for programmers? # {#faq_coders}
Yes. %Fungus provides an easy way to add visual novel features to any Unity game. It is also possible to extend %Fungus to customise the workflow for your team. Checkout the documentation and tutorials for more information. Yes. %Fungus provides an easy way to add visual novel features to any Unity game. It is also possible to extend %Fungus to customise the workflow for your team. Checkout the documentation and tutorials for more information.
# Where can I learn more about Fungus? # {#learn_more} # Where can I learn more about Fungus? # {#faq_learn_more}
We provide extensive tutorials and documentation on our website here. There is also a comprehensive online training course suitable for beginners at Udemy. We provide extensive tutorials and documentation on our website here. There is also a comprehensive online training course suitable for beginners at Udemy.
# I've made something cool with Fungus. Wanna see? # {#show_and_tell} # I've made something cool with Fungus. Wanna see? # {#faq_show_and_tell}
Most definitely! Please tweet @gofungus and/or post an item in the announcements section of our forum. Most definitely! Please tweet [gofungus] and/or post an item in the announcements section of our forum.
# How can I upload my Fungus game for others to see? # {#where_upload} # How can I upload my Fungus game for others to see? # {#faq_where_upload}
After creating a build, you can use a hosting service such as [itch.io], [gamejolt.com] or [newgrounds.com] After creating a build, you can use a hosting service such as [itch.io], [gamejolt.com] or [newgrounds.com]
# How can I report a bug or suggest new features for Fungus? # {#bug_reports} # How can I report a bug or suggest new features for Fungus? # {#faq_bug_reports}
Please use the forum to report bugs and request new features. You can also checkout our github issues list to see what we have planned. Please use the forum to report bugs and request new features. You can also checkout our github issues list to see what we have planned.
# How long will I have to wait for a bug-fix? # {#how_long} # How long will I have to wait for a bug-fix? # {#faq_how_long}
If a bug is critical and we can't offer a sensible workaround, we will try to fix it as soon as possible. Otherwise, we will aim to fix the issue in the next release. If a bug is critical and we can't offer a sensible workaround, we will try to fix it as soon as possible. Otherwise, we will aim to fix the issue in the next release.
# Can I get my hands on beta versions of Fungus? # {#beta_version} # Can I get my hands on beta versions of Fungus? # {#faq_beta_version}
The very latest version is always available at our [github repository] The very latest version is always available at our [github repository]
# How can I contribute to Fungus? # {#contribute} # How can I contribute to Fungus? # {#faq_contribute}
There are lots of ways to help the %Fungus community to grow! There are lots of ways to help the %Fungus community to grow!
1. Answer questions and post tips on the forum 1. Answer questions and post tips on the forum
2. Contribute code either via a Github pull request or post code snippets in the forums. 2. Contribute code either via a Github pull request or post code snippets in the forums.
3. Improve the documentation by editing the Docs folder on github and send in a pull request. 3. Improve the documentation by editing the Docs folder on github and send in a pull request.
4. Let us know on the forum if you've made a game with %Fungus so we can add it to the site. 4. Let us know on the forum if you've made a game with %Fungus so we can add it to the site.
5. If you write an article, blog post, podcast, etc. about %Fungus send it in and we'll add it to the [community articles] section. 5. If you write an article, blog post, podcast, etc. about %Fungus send it in and we'll add it to the @ref community_tutorials section.
# Are you planning to integrate Fungus into other game engines? # {#other_engines} # Are you planning to integrate Fungus into other game engines? # {#faq_other_engines}
Not currently. We're sticking with Unity for the foreseeable future. Not currently. We're sticking with Unity for the foreseeable future.
[gofungus]: http://twitter.com/gofungus
[Snozbot]: http://snozbot.com [Snozbot]: http://snozbot.com
[Unity Asset Store]: http://u3d.as/f0T [Unity Asset Store]: http://u3d.as/f0T
[itch.io]: http://itch.io [itch.io]: http://itch.io
[gamejolt.com]: http://gamejolt.com [gamejolt.com]: http://gamejolt.com
[newgrounds.com]: http://newgrounds.com [newgrounds.com]: http://newgrounds.com
[github repository]: https://github.com/snozbot/fungus [github repository]: https://github.com/snozbot/fungus
[community articles]: ../articles/index.md

2
Docs/fungus_docs/flowcharts.md

@ -13,7 +13,7 @@ Here is an example of a %Fungus Flowchart:
![flowchart example] ![flowchart example]
<!-- **************************************************** --> <!-- **************************************************** -->
# The Flowchart window # {#flowchart_window} # The Flowchart window # {#flowcharts_flowchart_window}
You'll need the %Fungus Flowchart window when working with %Fungus. Open and dock this window somewhere handy by following these steps: You'll need the %Fungus Flowchart window when working with %Fungus. Open and dock this window somewhere handy by following these steps:
1. Choose menu: ``Tools | %Fungus | Flowchart Window`` 1. Choose menu: ``Tools | %Fungus | Flowchart Window``

2
Docs/fungus_docs/getting_started.md

@ -4,7 +4,7 @@
Follow these steps to get up and running with %Fungus quickly, then learn more about what %Fungus can do and how to do it from the other documentation pages and videos. Follow these steps to get up and running with %Fungus quickly, then learn more about what %Fungus can do and how to do it from the other documentation pages and videos.
<!-- **************************************************** --> <!-- **************************************************** -->
# The Flowchart window # {#flowchart_window} # The Flowchart window # {#getting_started_flowchart_window}
You'll need the %Fungus Flowchart window when working with %Fungus. Open and dock this window somewhere handy by following these steps: You'll need the %Fungus Flowchart window when working with %Fungus. Open and dock this window somewhere handy by following these steps:
1. Choose menu: ``Tools | %Fungus | Flowchart Window`` 1. Choose menu: ``Tools | %Fungus | Flowchart Window``

5
Docs/fungus_docs/glossary.md

@ -92,10 +92,9 @@ Build settings include the target platform, screen resolution, input devices, sc
## C ## C
<!-- ******************************* --> <!-- ******************************* -->
**Csharp (C&sharp;)**: **Csharp (C#)**:
A computer programming language developed by Microsoft, similar to Java. C&sharp; is one of the programming languages that can be used to write scripts for controlling Unity games. A computer programming language developed by Microsoft, similar to Java. C# is one of the programming languages that can be used to write scripts for controlling Unity games.
<!-- ******************************* --> <!-- ******************************* -->
**Character**: **Character**:

2
Docs/fungus_lua/lua_controlling_fungus.md

@ -217,7 +217,7 @@ sherlock: Greetings.
]] ]]
``` ```
See the docs for the @ref conversation "Conversation System". See the docs for the @ref conversation_system.
# Flowchart functions # {#flowchart_functions} # Flowchart functions # {#flowchart_functions}

2
Docs/fungus_lua/lua_environment.md

@ -15,7 +15,7 @@ You can use multiple LuaEnvironments in your scene to ’sandbox’ the variable
The 'Remote Debugger' option activates the built-in MoonSharp remote debugger tool. The application will halt execution on the first executed line of Lua code and open a MoonSharp debugger window in your browser. See the [MoonSharp documentation](http://www.moonsharp.org/debugger.html) for more information on using this debugger. The 'Remote Debugger' option activates the built-in MoonSharp remote debugger tool. The application will halt execution on the first executed line of Lua code and open a MoonSharp debugger window in your browser. See the [MoonSharp documentation](http://www.moonsharp.org/debugger.html) for more information on using this debugger.
# LuaUtils # {#lua_utils} # LuaUtils # {#lua_environment_lua_utils}
When you create a LuaEnvironment object via (Tools > %Fungus > Create > LuaEnvironment), the created gameobject has another component called LuaUtils which adds many useful features to the basic LuaEnvironment setup. See the @ref lua_utils "Lua Utils" section for more info. When you create a LuaEnvironment object via (Tools > %Fungus > Create > LuaEnvironment), the created gameobject has another component called LuaUtils which adds many useful features to the basic LuaEnvironment setup. See the @ref lua_utils "Lua Utils" section for more info.

4
Docs/fungus_lua/lua_utils.md

@ -78,8 +78,8 @@ LuaUtils creates bindings for several useful C# classes and components so that y
| factory | The @ref lua_utils "PODTypeFactory" class for creating common plain-old-data types | | factory | The @ref lua_utils "PODTypeFactory" class for creating common plain-old-data types |
| luaenvironment | The LuaEnvironment component used to execute Lua scripts | | luaenvironment | The LuaEnvironment component used to execute Lua scripts |
| luautils | A reference to the LuaUtils component itself | | luautils | A reference to the LuaUtils component itself |
| test | Support for @ref unity_test_tools (if installed) | | test | Support for @ref lua_unity_test_tools (if installed) |
| stringtable | The FungusLua localisation @ref string_table | | stringtable | The FungusLua localisation @ref lua_string_table |
# PODFactory # {#pod_factory} # PODFactory # {#pod_factory}

Loading…
Cancel
Save