Doc: More notes for developers adding new PerformanceElements #6946
+90
−12
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
LordAro
previously approved these changes
Oct 28, 2018
LordAro
reviewed
Oct 29, 2018
| @@ -7,6 +7,11 @@ | |||
| * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>. | |||
| */ | |||
|
|
|||
| /** @file framerate_type.h | |||
| * Types for recording game performance data. | |||
| * @see framerate_gui.cpp for implementation | |||
There was a problem hiding this comment.
@see probably not necessary, it's mostly implied
There was a problem hiding this comment.
I thought it was annoying to navigate from one to the other, which is why I added it :)
|
I was making a step by step instruction but now that i see this I'll just leave it here and hope it can help and perhaps incorporate some of it in the doc. Only for the PerformanceAccumulator. If it's too badly written just ignore it. |
|
I might rework things a bit, put a semi-step by step guide in the file comment. |
nielsmh
force-pushed
the
framerate-code-docs
branch
from
f5411ad to
a6e1852
Compare
nielsmh
force-pushed
the
framerate-code-docs
branch
from
a6e1852 to
cdf178d
Compare
michicc
approved these changes
Nov 24, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'm unsure about the formatting of the comments, they probably should have some Doxygen formatting codes added.