Skip to content

Commit 12d51bd

Browse files
authored
Update documentation (#233)
* Update Doxygen documentation. * Add brief API reference to the manual. * Update CHANGES.md for 2.6.
1 parent a710a7d commit 12d51bd

17 files changed

+1194
-1930
lines changed

Diff for: CHANGES.md

+37-24
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
1+
## Version 2.6
2+
3+
* Added namespace `addFunction()` accepting `std::function` (C++11 only).
4+
* Added class `addStaticFunction()` accepting `std::function` (C++11 only).
5+
* Update the Doxygen documentation.
6+
* Add brief API reference into the manual.
7+
* Hide non-public `luabridge` members into the `detail` namespace.
8+
* Fix stack cleanup by `LuaRef::isInstance()` method.
9+
110
## Version 2.5
211

3-
* Introduce isInstance method and a convenience function template.
12+
* Introduce stack `isInstance()` method.
13+
* Introduce LuaRef `isInstance()` method.
14+
* Added a convenience `isInstance()` function template.
415

516
## Version 2.4.1
617

@@ -9,24 +20,24 @@
920
## Version 2.4
1021

1122
* String stack get specialization doesn't change the stack value anymore.
12-
* Added namespace addProperty accepting C-functions.
23+
* Added namespace `addProperty()` accepting C-functions.
1324
* Introduce enableExceptions function.
1425

1526
## Version 2.3.2
1627

17-
* Fixed registration continuation for already registered class.
28+
* Fixed registration continuation for an already registered class.
1829

1930
## Version 2.3.1
2031

2132
* Fixed registration continuation issues.
2233

2334
## Version 2.3
2435

25-
* Added class addFunction accepting proxy functions (C++11 only).
26-
* Added class addFunction accepting std::function (C++11 only).
27-
* Added class addProperty accepting functions with lua_State* parameter.
28-
* Added class addProperty accepting std::function (C++11 only).
29-
* Added stack traits for std::unordered_map (UnorderedMap.h).
36+
* Added class `addFunction()` accepting proxy functions (C++11 only).
37+
* Added class `addFunction()` accepting `std::function` (C++11 only).
38+
* Added class `addProperty()` accepting functions with lua_State* parameter.
39+
* Added class `addProperty()` accepting `std::function` (C++11 only).
40+
* Added stack traits for `std::unordered_map` (`UnorderedMap.h`).
3041
* Now using lightuserdata for function pointers.
3142

3243
## Version 2.2.2
@@ -44,42 +55,44 @@
4455

4556
## Version 2.1.2
4657

47-
* Added operator== and operator!= for RefCountedPtr template.
58+
* Added `operator==` and `operator!=` for `RefCountedPtr` template.
4859

4960
## Version 2.1.1
5061

51-
* Support for __stdcall function pointers.
62+
* Support for `__stdcall` function pointers.
5263

5364
## Version 2.1
5465

55-
* Added stack traits for std::vector (Vector.h), std::list (List.h) and std::map (Map.h).
56-
* Added ability to use LuaRef objects as an std::map keys.
66+
* Added stack traits for `std::vector` (`Vector.h`).
67+
* Added stack traits for `std::list` (`List.h`).
68+
* Added stack traits for `std::map` (`Map.h`).
69+
* Added ability to use `LuaRef` objects as an `std::map` keys.
5770
* Fixed some manual errata.
5871

5972
## Version 2.0
6073

61-
* Numerous bug fixes
62-
* Feature Requests from Github Issues
63-
* Added LuaRef object
64-
* Rewritten documentation
74+
* Numerous bug fixes.
75+
* Feature Requests from Github issues.
76+
* Added `LuaRef` object.
77+
* Rewritten documentation.
6578

6679
## Version 1.1.0
6780

68-
* Split code up into several files
69-
* Add Lua table and type representations (based on Nigel's code)
70-
* Reformat documentation as external HTML file
81+
* Split code up into several files.
82+
* Add Lua table and type representations (based on Nigel's code).
83+
* Reformat documentation as external HTML file.
7184

7285
## Version 1.0.3
7386

74-
* Pass nil to Lua when a null pointer is passed for objects with shared lifetime.
87+
* Pass `nil` to Lua when a null pointer is passed for objects with shared lifetime.
7588

7689
## Version 1.0.2
7790

7891
* Option to hide metatables selectable at runtime, default to true.
79-
* addStaticMethod () renamed to addStaticFunction () for consistency.
80-
* addMethod () renamed to addFunction() for consistency.
81-
* addCFunction () registrations.
82-
* Convert null pointers to and from nil.
92+
* `addStaticMethod()` renamed to `addStaticFunction()` for consistency.
93+
* `addMethod()` renamed to `addFunction()` for consistency.
94+
* `addCFunction()` registrations.
95+
* Convert null pointers to and from `nil`.
8396
* Small performance increase in class pointer extraction.
8497

8598
## Version 1.0.1

0 commit comments

Comments
 (0)