Skip to content

Commit 7b6b98f

Browse files
committed
docs/: Convert website .shtml to .md
1 parent 490b145 commit 7b6b98f

File tree

14 files changed

+181
-278
lines changed

14 files changed

+181
-278
lines changed

docs/devel.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Development
2+
3+
## Mailing List
4+
5+
There is a mailing list,
6+
[libsigc-list@gnome.org](http://mail.gnome.org/mailman/listinfo/libsigc-list) for libsigc++, to serve as
7+
a design discussion area as well as a place to report bugs. To subscribe, use the web
8+
[page](http://mail.gnome.org/mailman/listinfo/libsigc-list).
9+
Members can post directly, but all other traffic is moderated.
10+
There is an archive of messages,
11+
[here](http://mail.gnome.org/archives/libsigc-list/).
12+
13+
## Patches
14+
15+
Patches should be added to bugzilla bugs.
16+
17+
See the list of [open libsigc++ bugs](http://bugzilla.gnome.org/buglist.cgi?product=libsigc%2B%2B&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO") ,or [submit a new libsigc++ bug]("http://bugzilla.gnome.org/enter_bug.cgi?product=libsigc%2B%2B).
18+
19+
We also accept pull requests via the [libsigc++ mirror on GitHub](https://github.com/GNOME/libsigcplusplus).
20+
21+
## Version Control
22+
23+
libsigc++ is in the [libsigcplusplus](http://git.gnome.org/browse/libsigcplusplus/) module in GNOME's git repository.
24+
25+
There is also a [libsigc++ mirror on GitHub](https://github.com/GNOME/libsigcplusplus).

docs/devel.shtml

Lines changed: 0 additions & 40 deletions
This file was deleted.

docs/doc.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## Documentation
2+
3+
4+
We have both [tutorial-style](http://developer.gnome.org/libsigc++-tutorial/stable/)
5+
and [reference](http://developer.gnome.org/libsigc++/stable/) documentation.
6+
7+
8+
## Glossary of terms
9+
10+
For those which just want a quick look at the terms used in
11+
the system, glance over the [glossary](glossary.shtml)

docs/doc.shtml

Lines changed: 0 additions & 21 deletions
This file was deleted.

docs/glossary.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## Glossary of Terms
2+
3+
**adaptor** *(noun)* - A function which alters a slot’s
4+
signature.
5+
6+
**bind** *(verb)* - To fix a value of a callback's argument in the
7+
STL sense.
8+
9+
**call** *(verb)* - The process of invoking a callback or slot.
10+
11+
**callback** *(noun)* - A function or a member function which will
12+
be called when a signal is emitted. A slot specifies the callback and any extra
13+
data, such as the object instance, and extra parameters.
14+
15+
**connect** *(verb)* - The process of specifying the callback
16+
which will be called when the signal is emitted.
17+
18+
**emit** *(verb)* - When a signal is emitted, the connected slots
19+
will be called.
20+
21+
**factory** *(noun)* - A function which takes a set of arguments and
22+
produces a different object based on those arguments.
23+
24+
**handle** *(noun)* - A safe version of a pointer.
25+
26+
**marshaller** *(noun)* - When a signal has a return value, and
27+
several slots are connected to that signal, each one returning a value, then a
28+
marshaller chooses one single return value.
29+
30+
**safe** *(adj)* - Any structure which falls back into uninitalized state
31+
when its related resources are destroyed. Safe resources can be
32+
held throughout the program. Unsafe resources may point to freed
33+
memory.
34+
35+
**signal** *(noun)* - An object to which callback slots can be
36+
connected. When the signal is emitted, each callback will be invoked. The
37+
signal and the connected slots have a specific return type and parameter types.
38+
39+
**signal handler** *(noun)* - Another name for a callback.
40+
41+
**signature** *(noun)* - The return type of a function together with
42+
the argument types of that function.
43+
44+
**slot** *(noun)* - A safe version of a callback.

docs/glossary.shtml

Lines changed: 0 additions & 54 deletions
This file was deleted.

docs/index.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# libigc++
2+
3+
## About
4+
5+
libsigc++ implements a typesafe callback system for standard C++. It
6+
allows you to define signals and to connect those signals to any
7+
callback function, either global or a member function, regardless of
8+
whether it is static or virtual.
9+
10+
It also contains adaptor classes for connection of dissimilar
11+
callbacks and has an ease of use unmatched by other
12+
C++ callback libraries. Libsigc++ is licensed under
13+
the GNU Library General Public License, [LGPL](http://www.gnu.org/copyleft/lgpl.html).
14+
15+
## Features
16+
17+
* Compile time typesafe callbacks (faster than run time checks)
18+
* Typesafety violations report line number correctly with template names (no tracing template failures into headers)
19+
* No compiler extensions or meta compilers required
20+
* Proper handling of dynamic objects and signals (deleted objects will not cause seg faults)
21+
* Extendable API at any level: signal, slot, connection and trackable
22+
* Extensions do not require alteration of basic components
23+
* User definable accumulators
24+
* A variety of adaptors to change the callback signature: bind, hide, retype, compose
25+
* Most C++ compilers can be used. libsigc++ version 2.5.1 and later require a compiler with C++11 support
26+
27+
## News
28+
29+
See the [NEWS](https://git.gnome.org/browse/libsigcplusplus/tree/NEWS) file in git.
30+
31+
## Developers
32+
33+
The original library was composed by Tero Pulkkinen for the
34+
gtkmm system, a C++ wrapper for the Gtk+ widget set. The revised
35+
library was written and mantained by Karl Nelson. Special thanks
36+
to Esa Pulkkinen for development tips.
37+
38+
The 1.2 phase was maintained by Murray Cumming after Karl provided the initial 1.2 code.
39+
A long 1.9 phase led to the major release 2.0, previously maintained by Martin Schulze,
40+
and then maintained by Murray Cumming and Kjell Ahlstedt.
41+
42+
Then libsigc++ was rewritten for C++14 using variadic templates, for major release 3.0,
43+
currently maintained by Murray Cumming and Kjell Ahlstedt.

docs/index.shtml

Lines changed: 0 additions & 57 deletions
This file was deleted.

docs/license.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Libsigc++ is licensed under the [GNU Library General Public License](https://www.gnu.org/licenses/lgpl-3.0-standalone.html)
2+
for all platforms. Our intent in licensing it in this way is to
3+
provide it for use through shared libraries in all projects both
4+
open and proprietary. Other GNU projects may of course integrate
5+
and link in a static manner. The full body of the license is
6+
provided for your inspection.
7+
8+
This is the only license which grants you use of the software, so
9+
if you do not agree to its terms, you may not use this software.

docs/license.shtml

Lines changed: 0 additions & 30 deletions
This file was deleted.

docs/link.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## GNOME Links
2+
3+
Libsigc++ is part of the greater GNOME code base.
4+
5+
* [gtkmm widget wrapper](http://www.gtkmm.org)
6+
* [GTK+ widget set](http://www.gtk.org)
7+
* [Gnome project](http://www.gnome.org)
8+
9+
## Callback Links
10+
11+
There are a number of other C++ callback systems
12+
and publications on construction of callback systems.
13+
14+
* [Boost Signals](http://www.boost.org/doc/html/signals.html)
15+
* Trolltech signal system (part of [Qt widget set](http://www.qt.io/))
16+
* (Send us a link you find worth mentioning here.)
17+
18+
## Users
19+
20+
Here is a list of some of the projects that use libsigc++.
21+
(Have a project which is using libsigc++? Mail us.)
22+
23+
* [glibmm and gtkmm](http://www.gtkmm.org)
24+
* [Libpropc++: Creating and effective using properties in C++](http://sourceforge.net/projects/libpropc/)
25+
* [Yehia: Extension library with support for cross-threaded signal emission.](http://ucxx.sourceforge.net/)
26+
* [GFC: Alternative C++ wrapper for the GTK+ widget set.](http://gfc.sourceforge.net/)
27+
* [Libuta](http://sourceforge.net/projects/libuta/)
28+
* [The WorldForge Project](http://www.worldforge.org/)

0 commit comments

Comments
 (0)