cancel
Showing results for 
Search instead for 
Did you mean: 
SOLVED

how to do FB documentation in a library project

CodeShepherd
Community Moderator

how to do FB documentation in a library project

I created a new library to use in a PLC project. But the added header an documentation looks quite strange when using in the PLC. What do I have to do?

1 REPLY 1
CodeShepherd
Community Moderator

Re: how to do FB documentation in a library project

The libraries have to be structured in a defined format called "reStructuredText". This a setting in your library that has to set in the project information:
Library project informatioLibrary project informatio

There is an official documentation available at CodeSys homepage:https://help.codesys.com/webapp/reSTOverview;product=LibDevSummary;version=3.5.17.0

 

To use it an additional function package called "CODESYS Library Documentation Support 4.0.0.0.package" has to be installed. This is part of the ctrlX WORKS installation package but is not automatically installed:

ctrlX WORKS installation packagectrlX WORKS installation package

This has to be done by hand via the package manager in the ctrlX PLC Engineering:
PLC Engineering package managerPLC Engineering package manager

There some examples and information included in a new opened library project of the type "Standard Library:
Library project exampleLibrary project example


Icon--AD-black-48x48Icon--address-consumer-data-black-48x48Icon--appointment-black-48x48Icon--back-left-black-48x48Icon--calendar-black-48x48Icon--center-alignedIcon--Checkbox-checkIcon--clock-black-48x48Icon--close-black-48x48Icon--compare-black-48x48Icon--confirmation-black-48x48Icon--dealer-details-black-48x48Icon--delete-black-48x48Icon--delivery-black-48x48Icon--down-black-48x48Icon--download-black-48x48Ic-OverlayAlertIcon--externallink-black-48x48Icon-Filledforward-right_adjustedIcon--grid-view-black-48x48IC_gd_Check-Circle170821_Icons_Community170823_Bosch_Icons170823_Bosch_Icons170821_Icons_CommunityIC-logout170821_Icons_Community170825_Bosch_Icons170821_Icons_CommunityIC-shopping-cart2170821_Icons_CommunityIC-upIC_UserIcon--imageIcon--info-i-black-48x48Icon--left-alignedIcon--Less-minimize-black-48x48Icon-FilledIcon--List-Check-grennIcon--List-Check-blackIcon--List-Cross-blackIcon--list-view-mobile-black-48x48Icon--list-view-black-48x48Icon--More-Maximize-black-48x48Icon--my-product-black-48x48Icon--newsletter-black-48x48Icon--payment-black-48x48Icon--print-black-48x48Icon--promotion-black-48x48Icon--registration-black-48x48Icon--Reset-black-48x48Icon--right-alignedshare-circle1Icon--share-black-48x48Icon--shopping-bag-black-48x48Icon-shopping-cartIcon--start-play-black-48x48Icon--store-locator-black-48x48Ic-OverlayAlertIcon--summary-black-48x48tumblrIcon-FilledvineIc-OverlayAlertwhishlist