Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: More notes for developers adding new PerformanceElements #6946

Merged
merged 2 commits into from Nov 24, 2018

Conversation

@nielsmh
Copy link
Contributor

nielsmh commented Oct 27, 2018

I'm unsure about the formatting of the comments, they probably should have some Doxygen formatting codes added.

Copy link
Member

LordAro left a comment

Reads fine, though i can't vouch for the correctness/usefulness

src/framerate_gui.cpp Outdated Show resolved Hide resolved
src/framerate_type.h Outdated Show resolved Hide resolved
src/framerate_type.h Show resolved Hide resolved
@@ -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

This comment has been minimized.

Copy link
@LordAro

LordAro Oct 29, 2018

Member

@see probably not necessary, it's mostly implied

This comment has been minimized.

Copy link
@nielsmh

nielsmh Oct 30, 2018

Author Contributor

I thought it was annoying to navigate from one to the other, which is why I added it :)

src/framerate_type.h Outdated Show resolved Hide resolved
@dorobouNeko

This comment has been minimized.

Copy link
Contributor

dorobouNeko commented Oct 29, 2018

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.
add-new-measure.txt

@nielsmh

This comment has been minimized.

Copy link
Contributor Author

nielsmh commented Oct 29, 2018

I might rework things a bit, put a semi-step by step guide in the file comment.

@nielsmh nielsmh force-pushed the nielsmh:framerate-code-docs branch from f5411ad to a6e1852 Oct 30, 2018
@nielsmh nielsmh force-pushed the nielsmh:framerate-code-docs branch from a6e1852 to cdf178d Oct 30, 2018
@nielsmh nielsmh merged commit cb1fcc4 into OpenTTD:master Nov 24, 2018
6 checks passed
6 checks passed
continuous-integration/jenkins/pr-head This commit looks good
Details
openttd/commit-checker The commit looks good
Details
openttd/linux-amd64-clang-3.8 The commit looks good
Details
openttd/linux-amd64-gcc-6 The commit looks good
Details
openttd/linux-i386-gcc-6 The commit looks good
Details
openttd/osx-10.9 The commit looks good
Details
@nielsmh nielsmh deleted the nielsmh:framerate-code-docs branch Jan 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants
You can’t perform that action at this time.