Skip to content

Commit

Permalink
Document document_find_by_id() parameter so Doxygen is happy
Browse files Browse the repository at this point in the history
  • Loading branch information
@b4n
b4n committed Aug 29, 2014
1 parent 6e75598 commit 666fdf3
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions src/document.c
View file
Expand Up @@ -233,6 +233,7 @@ GeanyDocument *document_find_by_sci(ScintillaObject *sci)
/** Lookup an old document by its ID.
* Useful when the corresponding document may have been closed since the
* ID was retrieved.
* @param id The ID of the document to find
* @return @c NULL if the document is no longer open.
*
* Example:
Expand Down

4 comments on commit 666fdf3

@ntrel
Copy link
Member

@ntrel ntrel commented on 666fdf3 Aug 29, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops. I just updated doxygen.exe to 1.8.8, with 1.8.0 I didn't get a warning for this.

@elextr
Copy link
Member

@elextr elextr commented on 666fdf3 Aug 30, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If 1.8.8 is more picky, does it complain about any other stuff?

@ntrel
Copy link
Member

@ntrel ntrel commented on 666fdf3 Sep 1, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, multiple use of section name 'intro' in plugins.dox.

@b4n
Copy link
Member Author

@b4n b4n commented on 666fdf3 Sep 1, 2014

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, multiple use of section name 'intro' in plugins.dox.

Indeed. I didn't fix this as it looked harmless (IIUC it's only useful to create and use links), and that changing it would probably change anchors in the HTML output which we may or may not care about, but if there's a reason to fix it (or no reason not to) we can very well e.g. add a prefix to this section ID.

Please sign in to comment.