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

Added weapon documentation #11913

Merged
merged 5 commits into from Aug 5, 2017

Conversation

Projects
None yet
6 participants
@Mailaender
Member

Mailaender commented Aug 28, 2016

Closes #9880.

Note: I need help at the parts where the code is marked with TODO.

@pchote

This comment has been minimized.

Show comment
Hide comment
@pchote

pchote Aug 29, 2016

Member

The generated page doesn't make any distinction between the base weapon object, projectiles, and warheads. That makes it hard to understand, even for someone like me.

Member

pchote commented Aug 29, 2016

The generated page doesn't make any distinction between the base weapon object, projectiles, and warheads. That makes it hard to understand, even for someone like me.

@pchote

This comment has been minimized.

Show comment
Hide comment
@pchote

pchote Aug 29, 2016

Member

Please add some extra descriptions to the page that explains how there is a base Weapon that has exactly one Projectile and between 1 and N Warheads and then separate the projectiles and warheads into their own sections.

Member

pchote commented Aug 29, 2016

Please add some extra descriptions to the page that explains how there is a base Weapon that has exactly one Projectile and between 1 and N Warheads and then separate the projectiles and warheads into their own sections.

@reaperrr

This comment has been minimized.

Show comment
Hide comment
@reaperrr

reaperrr Nov 26, 2016

Contributor

There has been no progress in nearly 3 months, so I'm closing this for now.

Contributor

reaperrr commented Nov 26, 2016

There has been no progress in nearly 3 months, so I'm closing this for now.

@reaperrr reaperrr closed this Nov 26, 2016

@abcdefg30 abcdefg30 added this to the Future milestone Nov 27, 2016

@Mailaender Mailaender reopened this Jul 22, 2017

@Mailaender Mailaender removed this from the Future milestone Jul 22, 2017

@Mailaender

This comment has been minimized.

Show comment
Hide comment
@Mailaender

Mailaender Jul 22, 2017

Member

Rebased and resolved all problems now. Preview: https://github.com/OpenRA/OpenRA/wiki/Weapons

Member

Mailaender commented Jul 22, 2017

Rebased and resolved all problems now. Preview: https://github.com/OpenRA/OpenRA/wiki/Weapons

var infos = FieldLoader.GetTypeLoadInfo(t);
if (!infos.Any())
continue;

This comment has been minimized.

@pchote

pchote Jul 22, 2017

Member

Style nit: newline after this please.

@pchote

pchote Jul 22, 2017

Member

Style nit: newline after this please.

This comment has been minimized.

@Mailaender

Mailaender Jul 22, 2017

Member

Fixed.

@Mailaender
Show outdated Hide outdated OpenRA.Mods.Common/UtilityCommands/ExtractWeaponDocsCommand.cs
Show outdated Hide outdated OpenRA.Mods.Common/UtilityCommands/ExtractWeaponDocsCommand.cs

@pchote pchote added this to the Next Release milestone Jul 22, 2017

@pchote

This comment has been minimized.

Show comment
Hide comment
@pchote

pchote Jul 22, 2017

Member

Adding to the milestone because this will be a big boost for the mod SDK.

Member

pchote commented Jul 22, 2017

Adding to the milestone because this will be a big boost for the mod SDK.

@pchote

pchote approved these changes Jul 22, 2017

LGTM pending the style fix for this and anything else stylecop might mention

@abcdefg30

Looks good to me once these questions/nits are resolved. 👍 / Good work. ^^

@Mailaender

This comment has been minimized.

Show comment
Hide comment
@Mailaender

Mailaender Aug 5, 2017

Member

Added some newlines to makes this more readable.

Member

Mailaender commented Aug 5, 2017

Added some newlines to makes this more readable.

@reaperrr reaperrr merged commit fdad5e2 into OpenRA:bleed Aug 5, 2017

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@Mailaender Mailaender deleted the Mailaender:weapon-docs branch Aug 5, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment