Browse Source

docs: update them, merge PCSX2 initializers into one

new-name
parent
commit
493153b99a
Signed by: govanify GPG Key ID: DE62E1E2A6145556
3 changed files with 7 additions and 8 deletions
  1. +1
    -1
      Doxyfile
  2. +1
    -1
      README.md
  3. +5
    -6
      src/pine.h

+ 1
- 1
Doxyfile View File

@ -829,7 +829,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = src/pcsx2_ipc.h \
INPUT = src/pine.h \
bindings/c/c_ffi.h \
README.md


+ 1
- 1
README.md View File

@ -31,7 +31,7 @@ Meson and ninja ARE portable across OSes as-is and shouldn't require any tinkeri
refer to [the meson documentation](https://mesonbuild.com/Using-with-Visual-Studio.html)
if you really want to use another generator, say, Visual Studio, instead of ninja.
On Doxygen you can find the documentation of the C++ API [here](@ref PCSX2Ipc).
On Doxygen you can find the documentation of the C++ API [here](@ref PINE).
The C API is documented [here](@ref bindings/c/c_ffi.h) and is probably what you
want to read if you use language bindings.


+ 5
- 6
src/pine.h View File

@ -45,12 +45,14 @@
* IPC even complex events can be outsourced from the emulator, thus keeping
* the main codebase lean and minimal. @n
*
* If you are reading the documentation, feel free to browse through the class
* that targets your preferred emulator.
*
* Have fun! @n
* -Gauvain "GovanifY" Roussel-Tarbouriech, 2020
*/
namespace PINE {
class Shared {
// allow test suite to poke internals
protected:
/**
@ -1044,15 +1046,12 @@ class Shared {
class PCSX2 : public Shared {
public:
/**
* PCSX2 session Initializer.
*/
PCSX2() : Shared(28011, "pcsx2", true){};
/**
* PCSX2 session Initializer with a specified slot.
* @param slot Slot to use for this IPC session.
* @see slot
*/
PCSX2(const unsigned int slot) : Shared(slot, "pcsx2", false){};
PCSX2(const unsigned int slot = 0)
: Shared((slot == 0) ? 28011 : slot, "pcsx2", true){};
};
}; // namespace PINE

Loading…
Cancel
Save