API page: http://api.drupal.org/api/drupal/includes%21form.inc/group/forms/7

Enter a descriptive title (above) relating to Form builder functions, then describe the problem you have found:

There's a problem on this page with formatting. The part that says @ingroup forms @see ... at the end should be formatted as code. Probably the @ signs inside the @code...@endcode need to be escaped with \ or be @@ -- check drupal.org/node/1354 to see what to do.... I'll probably add more information to this later but making sure it's filed as a start.

And this most likely applies to 8.x and 6.x too?

Files: 
CommentFileSizeAuthor
#13 drupal-form-builder-formatting-1999074-13.patch534 bytesadaminnes
PASSED: [[SimpleTest]]: [MySQL] 40,782 pass(es).
[ View ]
#9 drupal-form-builder-formatting-1999074-9.patch594 bytessarahdavies
PASSED: [[SimpleTest]]: [MySQL] 56,820 pass(es).
[ View ]
#5 drupal-form-builder-formatting-1999074-5.patch579 bytessarahdavies
PASSED: [[SimpleTest]]: [MySQL] 56,380 pass(es).
[ View ]
#2 drupal-form-builder-formatting-1999074-2.patch499 bytessarahdavies
PASSED: [[SimpleTest]]: [MySQL] 55,864 pass(es).
[ View ]

Comments

Version:7.x-dev» 8.x-dev
Issue tags:+Novice, +needs backport to D7

OK, I had some more time today to investigate this.

The doc block currently says:

...
* system_modules_uninstall() or user_pass(), the latter of which has the
* following in its doxygen documentation:
*
* \@ingroup forms
* \@see user_pass_validate().
* \@see user_pass_submit().

This is actually correct. The only problems are that it doesn't format as three separate lines, and the @see lines shouldn't end in ".".

Probably we should just make this into a list, which will format them on separate lines. Good Novice project?
http://drupal.org/node/1354#lists

Status:Active» Needs review
StatusFileSize
new499 bytes
PASSED: [[SimpleTest]]: [MySQL] 55,864 pass(es).
[ View ]

I'm at DrupalCon and this is my first attempt to contribute. Please let me know if I did okay!

Status:Needs review» Reviewed & tested by the community

Works like a charm.

Status:Reviewed & tested by the community» Needs work

Thanks! Can you remove the blank line between the line ending in : and the start of the list? See http://drupal.org/node/1354#lists

Status:Needs work» Needs review
StatusFileSize
new579 bytes
PASSED: [[SimpleTest]]: [MySQL] 56,380 pass(es).
[ View ]

Here you go.

Status:Needs review» Needs work
Issue tags:-Novice, -needs backport to D7

The last submitted patch, drupal-form-builder-formatting-1999074-5.patch, failed testing.

Status:Needs work» Needs review
Issue tags:+Novice, +needs backport to D7

Status:Needs review» Needs work

That looks good! Oh, but I just noticed one other thing. The "End of defgroup forms" needs to be removed. You can see it on this page:
http://api.drupal.org/api/drupal/core!includes!form.inc/group/forms/8

The syntax is:
http://drupal.org/node/1354#defgroup
(syntax example 1 -- we only put "end of defgroup whatever" if there are functions between the end of the documentation block and the @} -- which is not the case here).

Status:Needs work» Needs review
StatusFileSize
new594 bytes
PASSED: [[SimpleTest]]: [MySQL] 56,820 pass(es).
[ View ]

Good catch!

Assigned:Unassigned» jhodgdon
Status:Needs review» Reviewed & tested by the community

Looks good, thanks! I'll get that committed shortly unless someone else is hanging out at the sprint making commits. :)

Version:8.x-dev» 7.x-dev
Assigned:jhodgdon» Unassigned
Status:Reviewed & tested by the community» Patch (to be ported)

Thanks again! Committed to 8.x.

The patch will not apply to 7.x, so it needs to be ported.

I'm going to try to tackle this for sprint weekend as a first project, has anyone started on it?

Issue summary:View changes
Status:Patch (to be ported)» Needs review
StatusFileSize
new534 bytes
PASSED: [[SimpleTest]]: [MySQL] 40,782 pass(es).
[ View ]

I looked up the list syntax in the documentation: https://drupal.org/node/1354#lists and added the code to a list, the text to be removed was no longer present.

Status:Needs review» Reviewed & tested by the community

Looks good, thanks!

Status:Reviewed & tested by the community» Fixed

Thanks again everyone! Committed to 7.x.

Status:Fixed» Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.