Library header documentation to be fixed

[BPerlakiH]

While including the library.h in XCode, it warns that the following doc is not inline with the code:

libkiwix/include/library.h

Lines 446 to 453 in 699cbcc

	/**
	* Sort (in place) bookIds using the given comparator.
	*
	* @param bookIds the list of book Ids to sort
	* @param comparator how to sort the books
	* @return The sorted list of books
	*/
	void sort(BookIdCollection& bookIds, supportedListSortBy sortBy, bool ascending) const;

[kelson42]

@veloman-yunkan What kind of glitch do we have here?

[veloman-yunkan]

@kelson42 It's wrong documentation (probably not updated after the method signature was changed, however it happened behind the scenes as in the history of this repo the docstring and the method are introduced in their current form).

[kelson42]

@veloman-yunkan I don't understand your comment. You mean:

• It's not a bug (not clear to me why then?)
• It has already been fixed?

[veloman-yunkan]

@kelson42 It's a bug in the documentation (the docstring doesn't match the code) and it's still there.