Skip to content

Commit

Permalink
Update Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Richard Schmitt committed May 6, 2024
1 parent c29c10f commit dd1c5b5
Show file tree
Hide file tree
Showing 10 changed files with 1,409 additions and 1,136 deletions.
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -70,3 +70,6 @@
[submodule "of_netbios"]
path = of_netbios
url = git@github.com:connectedway/of_netbios.git
[submodule "smbcp"]
path = smbcp
url = git@github.com:connectedway/smbcp.git
16 changes: 14 additions & 2 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
cmake_minimum_required(VERSION 3.20.0)
project(openfiles VERSION 5.0.1 DESCRIPTION "Multi-Platform Event-Driven Application Framework")
project(openfiles VERSION 5.3.0 DESCRIPTION "Multi-Platform Event-Driven Application Framework")

enable_testing()

Expand Down Expand Up @@ -167,6 +167,7 @@ if (DOXYGEN_FOUND)
set(DOXYGEN_PROJECT_LOGO ${CMAKE_CURRENT_SOURCE_DIR}/documentation/connected.png)
set(DOXYGEN_OPTIMIZE_OUTPUT_FOR_C YES)
set(DOXYGEN_EXTRACT_ALL YES)
set(DOXYGEN_EXTRACT_PRIVATE NO)
set(DOXYGEN_FULL_SIDEBAR YES)
set(DOXYGEN_GENERATE_TREEVIEW YES)
set(DOXYGEN_HTML_HEADER ${CMAKE_CURRENT_SOURCE_DIR}/documentation/headerFile)
Expand All @@ -193,11 +194,22 @@ if (OFC_INCLUDE_JNI)
list(APPEND DOXYGEN_EXAMPLE_PATH ${of_core_jni_SOURCE_DIR}/test)
endif()

list(APPEND DOXYGEN_EXAMPLE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/smbcp)
list(APPEND DOXYGEN_EXAMPLE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/configs)
doxygen_add_docs(
openfiles
${CMAKE_CURRENT_SOURCE_DIR}/documentation/openfiles.h
${CMAKE_CURRENT_SOURCE_DIR}/documentation/config.h
of_core
${of_core_SOURCE_DIR}/include/ofc/types.h
${of_core_SOURCE_DIR}/include/ofc/framework.h
${of_smb_SOURCE_DIR}/include/of_smb/framework.h
${of_core_SOURCE_DIR}/include/ofc/path.h
${of_core_SOURCE_DIR}/include/ofc/file.h
${of_core_SOURCE_DIR}/include/ofc/heap.h
${of_core_SOURCE_DIR}/include/ofc/handle.h
${of_core_SOURCE_DIR}/include/ofc/waitset.h
${of_core_SOURCE_DIR}/include/ofc/queue.h
${of_core_SOURCE_DIR}/include/ofc/time.h
${JNI_FILES}
)
if (CMAKE_BUILD_TYPE STREQUAL "Release")
Expand Down
8 changes: 6 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,10 @@ $(1)-$(2)-$(3)-$(4)-$(5)-test:
ctest; \
fi

$(1)-$(2)-$(3)-$(4)-$(5)-docs:
cd build-$(1)-$(2)-$(3)-$(4)-$(5); \
doxygen Doxyfile.openfiles

.PHONY: $(1)-full
$(1)-full: $(1)-$(2)-$(3)-$(4)-$(5)-full

Expand Down Expand Up @@ -369,11 +373,11 @@ all-update:

smb-init:
git submodule init of_smb of_smb_fs of_smb_client of_security \
of_smb_browser of_netbios
of_smb_browser of_netbios smbcp

smb-update:
git submodule update of_smb of_smb_fs of_smb_client of_security \
of_smb_browser of_netbios
of_smb_browser of_netbios smbcp

macos-init: all-init
git submodule init of_core_fs_darwin of_core_darwin
Expand Down
5 changes: 0 additions & 5 deletions build/deprecated.cfg

This file was deleted.

77 changes: 77 additions & 0 deletions configs/template.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
<?xml version="1.0" encoding="utf-8"?>
<of_core version="0.0">
<logging>
<console>yes</console>
<level>2</level>
</logging>
<devicename>localhost</devicename>
<uuid>00000000-0000-0000-0000-000000000000</uuid>
<description>Open Files</description>
<ip>
<autoip>no</autoip>
<interfaces>
<!-- zero or more -->
<interface>
<config>auto</config>
<ipaddress>192.168.1.1</ipaddress>
<bcast>192.168.1.255</bcast>
<mask>255.255.255.0</mask>
<mode>BMODE</mode>
<winslist>
<!-- zero or more -->
<wins>192.168.1.10</wins>
</winslist>
<master>192.168.2.2</master>
</interface>
</interfaces>
<dnslist></dnslist>
</ip>
<drives>
<!-- zero or more -->
<map>
<drive>test</drive>
<description>Remote for test_file</description>
<path>//user:happy@127.0.0.1:4445/spiritcloud/</path>
</map>
</drives>
<smb>
<fqdn>openfiles.com</fqdn>
<serveruser>user</serveruser>
<serverpass>happy</serverpass>
<max_events>5</max_events>
<time_period>30000</time_period>
<max_version>0311</max_version>
<ciphers>
<!-- zero or more -->
<cipher>aes128-ccm</cipher>
<cipher>aes128-gcm</cipher>
</ciphers>
<remotes>
<!-- zero or more -->
<remote>
<name>linux</name>
<ip>127.0.0.1</ip>
<port>4445</port>
</remote>
</remotes>
<exports>
<!-- zero or more -->
<export>
<share>spiritcloud</share>
<comment>test share</comment>
<nativefs>fat</nativefs>
<path>/tmp/spiritcloud/</path>
<exporttype>DISK</exporttype>
<encrypted>yes</encrypted>
</export>
</exports>
<servers>
<!-- zero or more -->
<server>
<port>4445</port>
<encrypt>no</encrypt>
</server>
</servers>
</smb>
</of_core>

Loading

0 comments on commit dd1c5b5

Please sign in to comment.