# Objective Provide a starting point for #3951, or a partial solution. Providing a few comment blocks to discuss, and hopefully find better one in the process. ## Solution Since I am pretty new to pretty much anything in this context, I figured I'd just start with a draft for some file level doc blocks. For some of them I found more relevant details (or at least things I considered interessting), for some others there is less. ## Changelog - Moved some existing comments from main() functions in the 2d examples to the file header level - Wrote some more comment blocks for most other 2d examples TODO: - [x] 2d/sprite_sheet, wasnt able to come up with something good yet - [x] all other example groups... Also: Please let me know if the commit style is okay, or to verbose. I could certainly squash these things, or add more details if needed. I also hope its okay to raise this PR this early, with just a few files changed. Took me long enough and I dont wanted to let it go to waste because I lost motivation to do the whole thing. Additionally I am somewhat uncertain over the style and contents of the commets. So let me know what you thing please.
		
			
				
	
	
		
			44 lines
		
	
	
		
			1.1 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
			
		
		
	
	
			44 lines
		
	
	
		
			1.1 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
| //! This example only enables a minimal set of plugins required for bevy to run.
 | |
| //! You can also completely remove rendering / windowing Plugin code from bevy
 | |
| //! by making your import look like this in your Cargo.toml.
 | |
| //!
 | |
| //! [dependencies]
 | |
| //! bevy = { version = "*", default-features = false }
 | |
| //! # replace "*" with the most recent version of bevy
 | |
| 
 | |
| use bevy::{app::ScheduleRunnerSettings, prelude::*, utils::Duration};
 | |
| 
 | |
| fn main() {
 | |
|     // this app runs once
 | |
|     App::new()
 | |
|         .insert_resource(ScheduleRunnerSettings::run_once())
 | |
|         .add_plugins(MinimalPlugins)
 | |
|         .add_system(hello_world_system)
 | |
|         .run();
 | |
| 
 | |
|     // this app loops forever at 60 fps
 | |
|     App::new()
 | |
|         .insert_resource(ScheduleRunnerSettings::run_loop(Duration::from_secs_f64(
 | |
|             1.0 / 60.0,
 | |
|         )))
 | |
|         .add_plugins(MinimalPlugins)
 | |
|         .add_system(counter)
 | |
|         .run();
 | |
| }
 | |
| 
 | |
| fn hello_world_system() {
 | |
|     println!("hello world");
 | |
| }
 | |
| 
 | |
| fn counter(mut state: Local<CounterState>) {
 | |
|     if state.count % 60 == 0 {
 | |
|         println!("{}", state.count);
 | |
|     }
 | |
|     state.count += 1;
 | |
| }
 | |
| 
 | |
| #[derive(Default)]
 | |
| struct CounterState {
 | |
|     count: u32,
 | |
| }
 |